From 1956e6b0026fa687e556f9c4e128aed7c9b211f6 Mon Sep 17 00:00:00 2001 From: John Duprey Date: Mon, 12 Aug 2024 13:40:26 -0400 Subject: [PATCH] CIPP-API-Processor --- Activity_AddOrUpdateTableRows/function.json | 9 - Activity_AddOrUpdateTableRows/run.ps1 | 12 - Activity_GetAllTableRows/function.json | 9 - Activity_GetAllTableRows/run.ps1 | 6 - AddAlertSubscription_Queue/function.json | 12 - AddChocoApp/Choco.App.xml | 15 - AddChocoApp/Choco.app.json | 65 - AddChocoApp/IntunePackage.intunewin | Bin 28368 -> 0 bytes AddChocoApp/IntunePackage/Install.ps1 | 61 - .../IntunePackage/IntuneWinAppUtil.exe | Bin 54160 -> 0 bytes AddChocoApp/IntunePackage/Uninstall.ps1 | 9 - .../function.json | 24 - AddChocoApp_OrchestrationStarter/run.ps1 | 21 - .../function.json | 15 - AddChocoApp_OrchestrationStarterTimer/run.ps1 | 19 - AddMSPApp/Immybot.app.json | 65 - AddMSPApp/automate.app.json | 64 - AddMSPApp/automate.app.xml | 16 - AddMSPApp/automate.detection.ps1 | 29 - AddMSPApp/automate.intunewin | Bin 2176 -> 0 bytes AddMSPApp/cwcommand.app.json | 65 - AddMSPApp/cwcommand.app.xml | 16 - AddMSPApp/cwcommand.intunewin | Bin 2768 -> 0 bytes AddMSPApp/datto.app.json | 65 - AddMSPApp/datto.app.xml | 15 - AddMSPApp/datto.intunewin | Bin 768 -> 0 bytes AddMSPApp/huntress.app.json | 65 - AddMSPApp/huntress.app.xml | 15 - AddMSPApp/huntress.intunewin | Bin 8912 -> 0 bytes AddMSPApp/immy.app.xml | 15 - AddMSPApp/immy.intunewin | Bin 752 -> 0 bytes AddMSPApp/ninjarmm.app.json | 64 - AddMSPApp/ninjarmm.app.xml | 15 - AddMSPApp/syncro.app.json | 65 - AddMSPApp/syncro.app.xml | 15 - AddMSPApp/syncro.intunewin | Bin 784 -> 0 bytes Applications_GetQueue/function.json | 9 - Applications_GetQueue/run.ps1 | 6 - Applications_Orchestrator/function.json | 9 - Applications_Orchestrator/run.ps1 | 25 - Applications_Upload/function.json | 9 - Applications_Upload/run.ps1 | 121 - .../function.json | 24 - .../run.ps1 | 40 - .../function.json | 15 - .../run.ps1 | 33 - Cache_SAMSetup/PermissionsTranslator.json | 5350 - Cache_SAMSetup/SAMManifest.json | 194 - Cleanup_OldAuditLogs/function.json | 15 - Cleanup_OldAuditLogs/run.ps1 | 9 - .../function.json | 24 - DomainAnalyser_OrchestrationStarter/run.ps1 | 25 - .../function.json | 15 - Domain_OrchestrationStarterTimer/run.ps1 | 36 - Durable_BECRun/function.json | 9 - Durable_BECRun/run.ps1 | 127 - ...osoft.Exchange.CalendarsAndGroups-Help.xml | 21498 --- .../Microsoft.Exchange.Management-Help.xml | 485 - ...icrosoft.Exchange.MediaAndDevices-Help.xml | 22140 ---- ...Exchange.ProvisioningAndMigration-Help.xml | 24606 ---- ...Microsoft.Exchange.RecordsandEdge-Help.xml | 17137 --- ...rosoft.Exchange.RemoteConnections-Help.xml | 12405 -- ...Microsoft.Exchange.RolesAndAccess-Help.xml | 77386 ----------- .../Microsoft.Exchange.ServerStatus-Help.xml | 21257 --- ...oft.Exchange.TransportMailControl-Help.xml | 2636 - ...rosoft.Exchange.TransportMailflow-Help.xml | 102658 --------------- .../Microsoft.Exchange.WebClient-Help.xml | 22032 ---- ExecAlertsListAllTenants/function.json | 10 - ExecAlertsListAllTenants/run.ps1 | 52 - ExecGDAPInviteApproved_Timer/function.json | 15 - ExecGDAPInviteApproved_Timer/run.ps1 | 5 - ExecIncidentsListAllTenants/function.json | 10 - ExecIncidentsListAllTenants/run.ps1 | 49 - .../Scripts/Add-CippUser.ps1 | 67 - .../Enable-FunctionAppGitHubActions.ps1 | 38 - .../Scripts/Grant-CippConditionalAccess.ps1 | 122 - ExecOffboard_Mailboxpermissions/function.json | 10 - ExecOffboard_Mailboxpermissions/run.ps1 | 8 - ExecSchedulerBillingRun/function.json | 10 - ExecSchedulerBillingRun/run.ps1 | 21 - ListGenericAllTenants/function.json | 10 - ListGenericAllTenants/run.ps1 | 42 - PublicScripts/function.json | 19 - PublicScripts/run.ps1 | 38 - Scheduler_Billing/function.json | 10 - Scheduler_Billing/run.ps1 | 22 - Scheduler_Extensions/function.json | 15 - Scheduler_Extensions/run.ps1 | 14 - Scheduler_GetQueue/function.json | 15 - Scheduler_GetQueue/run.ps1 | 52 - Scheduler_GetWebhooks/function.json | 15 - Scheduler_GetWebhooks/run.ps1 | 26 - Scheduler_PollAuditLogs/run.ps1 | 8 + .../function.json | 10 - Scheduler_RenewGraphSubscriptions/run.ps1 | 10 - Scheduler_Standards/function.json | 15 - Scheduler_Standards/run.ps1 | 6 - Scheduler_UserTasks/function.json | 15 - Scheduler_UserTasks/run.ps1 | 74 - SendStats/function.json | 10 - SendStats/run.ps1 | 23 - Tools/Clear-DevEnvironment.ps1 | 4 - Tools/Confirm-FunctionRequirements.ps1 | 79 - Tools/Initialize-DevEnvironment.ps1 | 17 - Tools/Update-StandardsComments.ps1 | 134 - UpdatePermissions/function.json | 15 - UpdatePermissions/run.ps1 | 30 - UpdateTokens/function.json | 10 - UpdateTokens/run.ps1 | 33 - Z_CIPPHttpTrigger/function.json | 72 - Z_CIPPQueueTrigger/function.json | 18 - 111 files changed, 8 insertions(+), 332471 deletions(-) delete mode 100644 Activity_AddOrUpdateTableRows/function.json delete mode 100644 Activity_AddOrUpdateTableRows/run.ps1 delete mode 100644 Activity_GetAllTableRows/function.json delete mode 100644 Activity_GetAllTableRows/run.ps1 delete mode 100644 AddAlertSubscription_Queue/function.json delete mode 100644 AddChocoApp/Choco.App.xml delete mode 100644 AddChocoApp/Choco.app.json delete mode 100644 AddChocoApp/IntunePackage.intunewin delete mode 100644 AddChocoApp/IntunePackage/Install.ps1 delete mode 100644 AddChocoApp/IntunePackage/IntuneWinAppUtil.exe delete mode 100644 AddChocoApp/IntunePackage/Uninstall.ps1 delete mode 100644 AddChocoApp_OrchestrationStarter/function.json delete mode 100644 AddChocoApp_OrchestrationStarter/run.ps1 delete mode 100644 AddChocoApp_OrchestrationStarterTimer/function.json delete mode 100644 AddChocoApp_OrchestrationStarterTimer/run.ps1 delete mode 100644 AddMSPApp/Immybot.app.json delete mode 100644 AddMSPApp/automate.app.json delete mode 100644 AddMSPApp/automate.app.xml delete mode 100644 AddMSPApp/automate.detection.ps1 delete mode 100644 AddMSPApp/automate.intunewin delete mode 100644 AddMSPApp/cwcommand.app.json delete mode 100644 AddMSPApp/cwcommand.app.xml delete mode 100644 AddMSPApp/cwcommand.intunewin delete mode 100644 AddMSPApp/datto.app.json delete mode 100644 AddMSPApp/datto.app.xml delete mode 100644 AddMSPApp/datto.intunewin delete mode 100644 AddMSPApp/huntress.app.json delete mode 100644 AddMSPApp/huntress.app.xml delete mode 100644 AddMSPApp/huntress.intunewin delete mode 100644 AddMSPApp/immy.app.xml delete mode 100644 AddMSPApp/immy.intunewin delete mode 100644 AddMSPApp/ninjarmm.app.json delete mode 100644 AddMSPApp/ninjarmm.app.xml delete mode 100644 AddMSPApp/syncro.app.json delete mode 100644 AddMSPApp/syncro.app.xml delete mode 100644 AddMSPApp/syncro.intunewin delete mode 100644 Applications_GetQueue/function.json delete mode 100644 Applications_GetQueue/run.ps1 delete mode 100644 Applications_Orchestrator/function.json delete mode 100644 Applications_Orchestrator/run.ps1 delete mode 100644 Applications_Upload/function.json delete mode 100644 Applications_Upload/run.ps1 delete mode 100644 BestPracticeAnalyser_OrchestrationStarter/function.json delete mode 100644 BestPracticeAnalyser_OrchestrationStarter/run.ps1 delete mode 100644 BestPracticeAnalyser_OrchestrationStarterTimer/function.json delete mode 100644 BestPracticeAnalyser_OrchestrationStarterTimer/run.ps1 delete mode 100644 Cache_SAMSetup/PermissionsTranslator.json delete mode 100644 Cache_SAMSetup/SAMManifest.json delete mode 100644 Cleanup_OldAuditLogs/function.json delete mode 100644 Cleanup_OldAuditLogs/run.ps1 delete mode 100644 DomainAnalyser_OrchestrationStarter/function.json delete mode 100644 DomainAnalyser_OrchestrationStarter/run.ps1 delete mode 100644 Domain_OrchestrationStarterTimer/function.json delete mode 100644 Domain_OrchestrationStarterTimer/run.ps1 delete mode 100644 Durable_BECRun/function.json delete mode 100644 Durable_BECRun/run.ps1 delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.CalendarsAndGroups-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.Management-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.MediaAndDevices-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.ProvisioningAndMigration-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.RecordsandEdge-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.RemoteConnections-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.RolesAndAccess-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.ServerStatus-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.TransportMailControl-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.TransportMailflow-Help.xml delete mode 100644 ExchangeOnlineHelp/Microsoft.Exchange.WebClient-Help.xml delete mode 100644 ExecAlertsListAllTenants/function.json delete mode 100644 ExecAlertsListAllTenants/run.ps1 delete mode 100644 ExecGDAPInviteApproved_Timer/function.json delete mode 100644 ExecGDAPInviteApproved_Timer/run.ps1 delete mode 100644 ExecIncidentsListAllTenants/function.json delete mode 100644 ExecIncidentsListAllTenants/run.ps1 delete mode 100644 ExecMaintenanceScripts/Scripts/Add-CippUser.ps1 delete mode 100644 ExecMaintenanceScripts/Scripts/Enable-FunctionAppGitHubActions.ps1 delete mode 100644 ExecMaintenanceScripts/Scripts/Grant-CippConditionalAccess.ps1 delete mode 100644 ExecOffboard_Mailboxpermissions/function.json delete mode 100644 ExecOffboard_Mailboxpermissions/run.ps1 delete mode 100644 ExecSchedulerBillingRun/function.json delete mode 100644 ExecSchedulerBillingRun/run.ps1 delete mode 100644 ListGenericAllTenants/function.json delete mode 100644 ListGenericAllTenants/run.ps1 delete mode 100644 PublicScripts/function.json delete mode 100644 PublicScripts/run.ps1 delete mode 100644 Scheduler_Billing/function.json delete mode 100644 Scheduler_Billing/run.ps1 delete mode 100644 Scheduler_Extensions/function.json delete mode 100644 Scheduler_Extensions/run.ps1 delete mode 100644 Scheduler_GetQueue/function.json delete mode 100644 Scheduler_GetQueue/run.ps1 delete mode 100644 Scheduler_GetWebhooks/function.json delete mode 100644 Scheduler_GetWebhooks/run.ps1 delete mode 100644 Scheduler_RenewGraphSubscriptions/function.json delete mode 100644 Scheduler_RenewGraphSubscriptions/run.ps1 delete mode 100644 Scheduler_Standards/function.json delete mode 100644 Scheduler_Standards/run.ps1 delete mode 100644 Scheduler_UserTasks/function.json delete mode 100644 Scheduler_UserTasks/run.ps1 delete mode 100644 SendStats/function.json delete mode 100644 SendStats/run.ps1 delete mode 100644 Tools/Clear-DevEnvironment.ps1 delete mode 100644 Tools/Confirm-FunctionRequirements.ps1 delete mode 100644 Tools/Initialize-DevEnvironment.ps1 delete mode 100644 Tools/Update-StandardsComments.ps1 delete mode 100644 UpdatePermissions/function.json delete mode 100644 UpdatePermissions/run.ps1 delete mode 100644 UpdateTokens/function.json delete mode 100644 UpdateTokens/run.ps1 delete mode 100644 Z_CIPPHttpTrigger/function.json delete mode 100644 Z_CIPPQueueTrigger/function.json diff --git a/Activity_AddOrUpdateTableRows/function.json b/Activity_AddOrUpdateTableRows/function.json deleted file mode 100644 index f87c62c534f8..000000000000 --- a/Activity_AddOrUpdateTableRows/function.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "bindings": [ - { - "name": "TableParams", - "type": "activityTrigger", - "direction": "in" - } - ] -} diff --git a/Activity_AddOrUpdateTableRows/run.ps1 b/Activity_AddOrUpdateTableRows/run.ps1 deleted file mode 100644 index adc07df73e23..000000000000 --- a/Activity_AddOrUpdateTableRows/run.ps1 +++ /dev/null @@ -1,12 +0,0 @@ -param($TableParams) -$TableName = ($TableParams.Context['TableName']) -$Table = Get-CippTable -tablename $TableName - -foreach ($param in $TableParams.Entity) { - try { - #Sending each item indivually, if it fails, log an error. - Add-CIPPAzDataTableEntity @Table -Entity $param -Force - } catch { - Write-LogMessage -API 'Activity_AddOrUpdateTableRows' -message "Unable to write to '$($TableParams.TableName)' Using RowKey $($param.RowKey)" -LogData (Get-CippException -Exception $_) -sev error - } -} diff --git a/Activity_GetAllTableRows/function.json b/Activity_GetAllTableRows/function.json deleted file mode 100644 index ce320a44c1a3..000000000000 --- a/Activity_GetAllTableRows/function.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "bindings": [ - { - "name": "name", - "type": "activityTrigger", - "direction": "in" - } - ] -} diff --git a/Activity_GetAllTableRows/run.ps1 b/Activity_GetAllTableRows/run.ps1 deleted file mode 100644 index db63ea61a8cb..000000000000 --- a/Activity_GetAllTableRows/run.ps1 +++ /dev/null @@ -1,6 +0,0 @@ -param($name) - -$Table = Get-CippTable -tablename $name -$Rows = Get-CIPPAzDataTableEntity @Table - -Write-Output $Rows \ No newline at end of file diff --git a/AddAlertSubscription_Queue/function.json b/AddAlertSubscription_Queue/function.json deleted file mode 100644 index 12e3dfc77c46..000000000000 --- a/AddAlertSubscription_Queue/function.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "scriptFile": "../Modules/CippEntryPoints/CippEntryPoints.psm1", - "entryPoint": "Receive-CippQueueTrigger", - "bindings": [ - { - "name": "QueueItem", - "type": "queueTrigger", - "direction": "in", - "queueName": "AlertSubscriptions" - } - ] -} diff --git a/AddChocoApp/Choco.App.xml b/AddChocoApp/Choco.App.xml deleted file mode 100644 index fb0aac775d73..000000000000 --- a/AddChocoApp/Choco.App.xml +++ /dev/null @@ -1,15 +0,0 @@ - - Install.ps1 - 28319 - IntunePackage.intunewin - Install.ps1 - - bmoyHXFtIws7JrnXNDV4rjzap+Be+4ZJEDJkTfbVIL8= - xNh8ZUZ6TLsAtihUEAU/NHiRfutDzz+eSgEdpaXUo9Q= - 3aQFPhO8ywEC4Ojby1lR0w== - PXX+hj3DXEpzMEMYBDXmAIlSyDIGuAwmAHIQpZIt8hU= - ProfileVersion1 - fx41h3rGZYZO3Jux7JnPgatlmpMc2ZFIZS8ipF5VDDw= - SHA256 - - \ No newline at end of file diff --git a/AddChocoApp/Choco.app.json b/AddChocoApp/Choco.app.json deleted file mode 100644 index 7ef3f82d640f..000000000000 --- a/AddChocoApp/Choco.app.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "displayName": "", - "installCommandLine": "", - "uninstallCommandLine": "", - "description": "", - "developer": " ", - "owner": " ", - "informationUrl": " ", - "privacyInformationUrl": " ", - "fileName": "IntunePackage.intunewin", - "@odata.type": "#microsoft.graph.win32LobApp", - "applicableArchitectures": "x86, x64", - - "installExperience": { - "runAsAccount": "user", - "deviceRestartBehavior": "allow", - "@odata.type": "microsoft.graph.win32LobAppInstallExperience" - }, - "detectionRules": [ - { - "@odata.type": "#microsoft.graph.win32LobAppFileSystemDetection", - "path": "%programfiles%\\7-zip", - "fileOrFolderName": "7z.exe", - "check32BitOn64System": false, - "detectionType": "exists" - } - ], - "returncode": [ - { - "returnCode": 0, - "type": "success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1707, - "type": "Success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1641, - "type": "hardReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1618, - "type": "retry", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 3010, - "type": "softReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - } - ], - "minimumNumberOfProcessors": "1", - "minimumFreeDiskSpaceInMB": "8", - "minimumCpuSpeedInMHz": "4", - "minimumSupportedOperatingSystem": { - "@odata.type": "microsoft.graph.windowsMinimumOperatingSystem", - "v10_1607": true - }, - "notes": "CIPP Uploaded application", - "minimumMemoryInMB": "1", - "setupFilePath": "install.ps1" -} diff --git a/AddChocoApp/IntunePackage.intunewin b/AddChocoApp/IntunePackage.intunewin deleted file mode 100644 index f388884134ed6934bbe64c6593dcda5236d9ad09..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 28368 zcmV(zK<2+ab^eAu!(2*pFhdvwHRb?`Qphp}xC|x$auB7GE%FuJqy;_`yvqRs;ON`S zSy9tIaA-R)Z{VvgGBd+hhVkRRDlHi4knlur2eQcsJVFUJ12Vlr%sz9rl?Fz3oXyy5 zTI|1AaE4!ETO`(Ow2_`cwVJls;YAd&nA3y+R|3nItZWd~c%q}<`ejb!@U(VuLLsC3 zWITEH$ZAj+?aPwT6DJw<>Ujj!+O;Dm!u9)u9WReg6?v?XDXD&kVJ4AzG;P@^L)twM z;)BQ$FI?J57_>Ck=BPqrP+onJ6^N5c1)9Su=4jw}P0gnfU4-KPHDb|+>*c#xIOZwR za5p?5LnorlYR#()MhJaO;IWEwuhvsY>_*z#W}U~^#p)UyQ_Oxbl*)aJosN)T`&byN zCUEWB;2z{n*!!%Pa*ZYlZsCrb7!@3o#xl)LsKyo4zgBBnT8u-Iuz7UPhGi$3I}Y=h$vzCM^zfOqGZv0eu+t)9?LV zs1M8Dyw73x-ZR|Qng{RwP}w8t{MB!vBSaARBfk}6S*Xyg(TLfqSqz_mQRD!xxf298FU%v>v5@mlosxErOfrj_of_1-qIP-Rp`P2 zh68^%A}m-T(xpPMmp5y!wDr_`&pK09;8__>)55-XS|6wf#xNF%`Tf z;k2`>O18u-vC4>tytT8LlhCS~S9xoJPYA1y)BC zXj5$R*fJXPXRg-Z^*4Zl2?pDPbky{`s@u&8h5U>xe;{sVv<& z>y(R8jHn*UDvF7MawmTVy40-P3vIu$*z_po0k)_AE_3_|ob%bypX>J7n)XMM{swzmJcKkx>tGudNy>z86{1pqcMmKUrUA;lzM zX#${tI(AT3=Uv(pW89=>ysSq$OCMza-vlBkpUyBE%j~dTaeymPZ?ON)$gn5K40%;P zW1x7i@^Lar@Rr`zS~5`ov$T1uJ3MZ4axsy&$UrYC9p%ET1o0k@__2RxQIi1^FG0W@ z$|rT$UV`5<*ZHy->o|I15$^G|5^6i~Pj(idNYs^=P4qrntEIu8b)jqhuwd?X+PS;b z^#NWkLEinC4gX0pd$u)LM`zCsY=UER5A%GQUdB8u{;W%FJ(kN*4#(F_^&P2N?p zq!}u4@lW7(%vj9~`2ov)ugH-Z$_ON>LE5`d(;VYQN5w6!r48SLa`IpMgT$#f>$NjN zpcnm9s4%;;1%sSS3N;%_WmVS!!KhDz!l|nf^faLWkW#lUVX0HhOwaW!O>9bZ{F7bm8v+Zl$#dJ%8zxN9kcp1L710oSPdY ztWjt7%(mkn!AO>u<>%z)lTtB_qjChy9oO5iG1H39rbibUsy0&Dwa| zRB?|}QrS3WKLV7}-2Z&Q^G!Vol%H}QNE_uM(EM|OU@E*tjcFJfc1I+oA~BS^zh#9@ zzd$th8tK)gwGBug?-}ju%I7a(d<@`^L$UTkvb9+)LBiN?00BpxN@1LmxlmVjR(KoW6u^lKGP^z77bljTT$F0|lVwFgCg3<H?>2yUQmt|&Dxuk6k?JIM7sbjV}c>gbLXM$WwF<<&-bYzN&MUgYj;;+Ra2f@%VzLmTUW7oa|oI0b&G= z@^}k^qsbx5FX;9Zpv_r#V>-4(+wYG8IO1dyu8T*2<-e)tzY<2+g$VvA5@%qy8d% zXQp{7q$#bQ+5Q))?YmXi=7tnz+&psOzR5EIAkJ~9E1D}8aJCPMT16EB61cjN!D zjk-|=ZRhO*U5(080Sh?Sp(79-KF3@5=#w4mZ^Cs2FP95_7q7bFZ1u1s2$Rx_SzPj3 zH#~aZQ_99N9IE@)3GXJCs0vXK1PBTI({oD4E16Gd9tDbi9V!OXwEhxjM54T z7G(=Gi$!cnVzYa78Ts7Qy{rcAq1V;Tmc^dM%WvrgkiXWwlVDZ1LDCZ?Ocy6WQCs`n zV_I7>S0rbJLTWslENHcyA;B8u1pm$p4qJhxN(6F&db<_{kQ`z7CGR5{kFcS@*9Y6+#`xtB9TyIk z^pyJhTCy9D*^9=nWxr{T9i|3N@onI&YW%$`tpQC66!cO1Sfe1wZ@Mk^@UC6V?2nlJ z_fIx}2ygC#F0x>7rk>qtYJPAF#IKs`qxR2A`yf3BAn)Q51_Hnobs67>!#d6Wp71>m zF$N&8%ui0*q@8sd4iklk@8QzSpCJi>a#@Gr57Jw0m4&-To1R8ML}BHBR5O!1 zl2xCs491CQgE6S8i<;k(j6gDahrx`)K!Te^e?c4yIK{h`k|6Im)S}m)S}|YKspqQc zVO}wx3Jg2vu=H~vMcu6yzKz zWC|65+gm$%_F8)xOO!_pAlg92fr)$YS|5K~qsKTZ-mUhUy?i@%#Wm7SS=3(PXxXk@ z9wC(?-_ddk%ZF~;e)s_O;Z@pz0TW3vKjCUP2NY2C&bJ+=kypJ}xkw#1Xn<K)c4dD!nn_lE*h$zo&6VKJx8pw{)!GNO`K)=Mr8jfVt z<}}uGVzLmCgg)5;@VriLn-G@~gtUF1Mj7cN^ssM*NKiV8Oa_%TzlM?+Xh~U9^gU|Z zR)FzF{D=UYm#Ir73}_x!9fPaHm(6dy&M%JrGax4A^J64$>n==R_KkW(i|$Cfh*iX- zUe^ux&6&Gvp!bv2;ZcPsA7Iz~v)`p8+Z#QqaDiC|Iv3-~M0eC3Ud&BcuVFUpS?w7u zu8$q;J(;Vc+jcCV{cN#sp2L?9qTs=slaCJ9V)XhXIg^fuN8EKLypv2E>?iMtJ| z$P3^oEClHl%Aa_Y2F$F<$tiXAUi}rzGIDkZ5_4pbuuc76yRZ_hUGDf%J~75!4@hYo z7TN>t2=|O0W#PpgPpSLFn|DBKPt4Ej$K)aExH{~iTL-_h+Jg8(3QnRoD{zCI@{ zH>)$ynjs1<#rA3Cmc|pwQ<_r+$w34Q{T4HSm=m-h{?CxXUc`53&JU#=*qDr- zk|*nF`cTVN;;xNnnf+IK`!DU3RhA%?TWDPmjHK4@=TEFQC_BMOTmpMHphD|j>b19Q zgi5Y_A~Nn4#wK%Eyr^nB#jV`TSOKwR;!MbiNToO)4Gb}P5c5YFI0;H}fmh<41A$#- z?qJV++$G;k@)_PbNihTcJkS)V`?F=`lK@ghJ2QYCY~5+I1CX?aCF|eSA%J|!Y;sxY zDz6trt1x6B7K2O%d~ajsM2uY|{mQ*RNzl9u4^Roji2)AJ4~Hly66jgfF(9D(=A_}# zZ{pP+itXBH&dh6gw2bgSl;z@xXxs=0>Q<_{X;S5Mfcfgq(J%(5zYd9Qb7?GiHn~h_ zAf(B7M-8UeeDqG_*xXq;?Sr6N_| zebWP#%qMZgD=1|D+p@)f`=^jegHbe&h>6sh1tbK*%1-U zcTUNVAoQDOR_vQc&=-it@V6z(EsZpJba(rfOsRP7DNQy$ck}r|Xu9^J89)cChNOUb zi3iARWH6^&3AG|5UGYhX;YpTRMd{zPUhFEJBY9#BA34R~+i}%22mp^F-b258geeH( z*Aq0r8Hb-qO|tqqeVH@0}+o_BrNbMT_EdgUw7w$GpxFgnI4B(61(Cf_TzgVw!`cf%d*kohgyZS;4B z->}}E!Xo=etwY}#kt<26vKcIy!#3?15!HFm{PN~$gx`oNUZNVV^FgziNtZYVepL+3 zPF5i8SU-hO`V%D2g94^>CAVdeA<@iFp_l10+7B@48+5$flY_XILGC^OHGdp;fS7XZ z>#$G=KWjI!EU;g_Yo>Vn0in3CJ#U5gXQFt7w5KZqeX{^x6j0QKHPKYM znOgLe?fYu@aYg99`lxh!fpJ1z|cN7LR26 z4CHo3OTDaB*B>_^8FP~xN?OtLW4S}eZXk$MuzzJ%S71t&9OsSOSXer z=Q#Vep8kC|#!e!z-LX-QknhBgT4LHG7iiiQ#+KP;^8RT*W+B9<%p`r*_;UTtj4=Nc zsLg&O|M$GX1zjj7hf>ECa{<2*{{Y0;HfBW!Ugd}cC3odZYny4^{V+w?{7LFe55aeM z0;QNEuhhkra(oGqq^qLK(2;DbHIX}uon!0~2WBgc@96%oe>%EBfsnEui~7BgF5aG&ymh=*yqWL@>vlC@S039j-tGCwxF)^n}>x zkczS(IRqj*KcR6^*Rygkob^`y&+cn~fs0B<5w3om@73>0#|zm;dJ68;yVbp@7U@K> zj95Hg{q+S33ev7bp)!b5NU(hy63wvZIi#30+ruo!3pJ=7a|SzAQUjxI5UUzhP0t)W zYSi1EW|Cw&K+PVT#)QJ$l8&1N!hURmX2iI@jYvs7$=-O$*A(d~NSMuJ=Y8|z1GC%5 z`bFEAvF6}~+M(+PmQ8+-`azZksJknsHXJ9+)yacL*DR@bTftc7OKeLZ%*nOK$>RZ~ zOfPM)-YKghY=&vIKMxX|YK#9MzWudx{Whf58{xFXM^t!1Oef1)>=NY;rBQ)dbo=)4 z4Q`YPm@#;5U=q?%!B(DdzUHZbK>QQ}c9<1BV(c+<5kwC25j0}NTfyEn)mD;CV5on^ zgIcwBm$d)`5E=O*fJA@i7^44-@A4(?86&h7z@Pb^9Qk+TLsNn`8rd>qRk%wlC%7Ay;8dcs9lt8(BD3Gn zzKn*+KnEYYDtgD)1yvmin>S~&~0|J86F^VRO9$i1(^t=IfKDU-pZ z%Ax{KDd0^rbbn^(Q_B1OEzp;R?uaszaX#jO9EFvI3%J*P@C>|X|_ z3#!|ZX}6vwyT!S;Sv1~FWz=gFL#Uqct9rEP5j8&xC$r)|kN%eaZhR}PBZ75b-Sm%b zXFENI7m$sIYd_+ih9x`~etD2eK4qDjbg)vs)1ccXc#+AG$TO5&@T9V&-T0#s>Hrcq zM1wpKOmZd9f=3nI7G<2{c4ui#GJycGpQJwyaTvy+p5pG@ra-(&@m{*=zU8@F)6iW) zD)*76d^!2Qp~t1kTe0SKUb#~t41u`BvUdaEcC9D4mup!HRbp=@nL386)(D#VSAWX* z^~yE=uaGxxS*cfnABg#PXdXcXO-Ue+}Iu`*&zVr>kTUGN1{WlZhWsMdKshhGUDA# zwGDVWm4kejo(~peTY*r7+oim;>p)r-m|E*R>3+SQ7>j*xh#T{K#g9U+V!C&7i?X%| z`J8Vbg5QZ@|MUc7ZpF-~>D&!?Qipa4cOc}o7REDWdYe!KdAG#rav#=h9eKxKVDFM0 zVZG6hHd2fWFT~dW@J#VuEF*z^dK*m1xI6)x7Uv;UiY*3B6x8}aM{{2n4`Zx;+OF`Y z580vWJI%S4529loS9K@*dy#@xqY==192_@pOfNmCET^#(|P7QGow2-@Tb5KMn zGF^~Q?D6>>a599-OkKU-rg7EH`{>V?K}8a6<6?Y4kz|Q*K-8|R3;mxwHd^f)Qe`Dy zk+e4AT(7ITGOL%_NI#beJBL~a&RiQ^UYAO{ShI|P2<^V}o!GdXC4o{Z<`0s2i!_=& z)RZA~oQFdlEH9}%q?cpkp1Ct2{nyUF=9&feVRf1O7riI!c5out@5b2Ava%YD2p@P< zC%kjEoj-|bWgc?M$dcW;apc^zpfVA5)6I~}z!&Ie))%tI_{8N+wA0d!1$8g zwsN{BMwqYbehD=AoyJe3h}|7PS;&OHiP-pG<01UnDuIAJ*PME)IHFr^)z~{Aw~~;` z1}Wj%AFR%}(c@6-V4*<#5ofbvrNIlj;?jeT?vrn_`(!w8;2&b}(A9cssa!R#jTKAd zLlbRBA;S9*wXfC1158qZQS-`F2GVSxhHW{Uxu|lBk#StbR(+sm+gYo}Dq>s^Z3iGM zd#No;ilu7Zj#)}h)U~q`mQjh@$S@6E;byXq@P|3Pl5@UmTx@X_YddVRAX;kg68Dbo zcwAc{ZYD$(Mbf9!oeM64XXHN4*6B%vOHy>QT=*5Re&29*D5s$Pa1TUnnFl9G`nmMt7{vh?x5j? zO-CotYX_YCpzvc4?t|jTe36Qyo2q1>(1A}jcIEs+c&yKNa%<%CC3RF(5 z{_Wqsx|WdB<@5$Wfo%SSEnr4ZR&kOVHe^z}>gwg9k8%XVBS zS!1aLI=>8JW;q@aW7;5gFkoRpzi+Bl8`qrB8J{Uap6q_2q3rJdXSNIg2!$yDbZ;Kt z*WS$=RqiRMu(`K+;8D2=BDm?IqSQ)PP=e`CeaBf3b_=Hvl5k7bl?znOOt2c70A|kY z42|%I1^<05T~qG0Cy5t>y-a9tZ7dVBi>qE8%Deo3sf|2GlNEe9{BL-uMrM9OAi7Dg zLL?Cu$zH~McRUDmG5_=!tZz?F=3F5S+7t+0jxxbh0|`6 z5Yq50hxwggsms$`d^USLAv$~w=R%}7>iXwkdrZ;u%I+ivw-TLJ4u)~BYfvmRc!}89~D15**j%~&a zOYg*j9@BlowZA_&6B#2fDeLb_hsg`0({F!$WWQYbqbvw?%>nmb(u0-BPJdk~P9*}s z6~>TIjKBR;L~s|C{sM2%6G#s&#FvXPSsdK)ltnGv6(H}pY|%ylftDYzDu1j`V-q99ednmgT`V1*=5WY1p^=Jrx%HI(YV}>);`5a zovtbCR)JTT(c%|P_u2KS-o^ISFi2&WbyZh!IF79uwmhC_xYSyRG=Awix64_1LMjwp zOlSSD-QI~xRvl{eKD z{?K9ZI11{X5OhL*)l%Q04;R^a7V;5itGmg?*$dx7*~=4(){?%y@P_xO?m{W<;V$+D z`K53qX$tq((zK5!S&$k^bs$!;cdr#ZB($V}16Na1EX;WUf;Gc(M+}_^>QEbcbeqiU zVxs~+$Y19d@Uxa>hCdin;CTj*e#o-D_jq3|irewjR1*NpIrVIN*dyBb@V>`nu1SH& z{PeBDzHuxcdXa(`KAC9Px=yqS6sRdoKeV7|uI$04w5cyT%VcT0Pg!yjd!6i8sd1q7 zv9-%f_Ne}@N{g?-SP1jmBxX@8@yc{-{TR%&f!`vRXZ1Y}2!=IBDJAhmJzU}lfW)}(v@aN$K3f00x_ZTCRD4d%& z&*PX^jTWCLWDdK7lA368_3@ARRts?S;XaW;%lm<5xoJ$qU-_)UY1$RY$|N4Khqf{K zY72PLbzdl*WtYBV@a7hc!x$*Bp}J7 z!KmJnCx#E_Q`=lw^!1%f+Q|vjO-YZ$$y;mz6a*W{h-do+HhsUBwllbnq{PD+6+?1w z-zA?#6A{b@l)s&WLxa8(cWdv~Y*=WB;U5q8+R}BN95TH66fpEzP#6275=|x|j2*?v zr)sU!cnti4DKBik(im-jepZo3&-e^{H0y{*W0PQ`FyO1Q!j*fwbpMWR9`ZhUMZX?* z4~k=MP5u)L1y@WNF-@=ixzMUufKp+g3^ExGW0a&cOF^(xxm*3iOQs$*(@&_}Ste~i zFCz#I5&mLYy>La2(!6QP7*9PW8x@()?bT2x8uy*P-4%JaoVxjx$vG@k%j6eGX=3@B2E$rpt~2HJ*F>@60u zbSOF5Rg@fJeAD_-O_g1cv8RWDlb8y9%n$6AVZ~ZLyc;Mt9Z`zsmt@xEK9xkJa_plf z)<+Tiw`1X~9h`oGz#O(;!>pe1WPs{F6YKD<>~x|n`^)6RB}Hlj7I>oREzwHPg6}1L zsNRJY&RmD^3(B&94mhhxUf!pE57icFg9;^t%9yOcu)l@b6fk1){z zKqKI2(UWETtU~~``rqG2aC@I(}gqOI$BU2``3(JvG{V=LD!q$^A%;2ud?2csUZ^52Q@9 z_SO?SUq~=`_nlb-E*vz{(baRqzZZu-03_8OV4PO%_THYV|D`#6tqog-+5B?aCGdBI z^O=W`j>D%LeH~dloG6kF8T#r8lfx9*G~0&OZ4=SIy%N!|ZcH2LkQ!Pw65cz=--UE4Q$7v97FLL*B=il}3UHZtEW z7k-D0!7hp>tY)Y1nlP&Ja4}QUfjCc#IlD2yin}(`e=aW0>*ut1^VH5q9u*;(2!c$I zfT+R2>HOTkjvonUpM6~kgjh1ls-d~F5}R2DN|%oY%^>W=PGuq&3}^-g$Ztbd1CInC zAKt#;x(Q1Acv#pko(-zFC|?|1vd0UgJpVzam+Bf~uh)=~J94Q&R|KR1(c$ERuDh14 zp`C7rESOHQ9hGd&o31<|vk6I@*kCdI{f3E?DO64L_Ub9od6}2AW-0KU(}Ro;e9v>A z!?TJ=dJh8>neiKPnQT?3reogo$cr8fHzw)_D|jvTs3-bn)|MwU=CD4zegfu66%I@u!4@(dbmho=_5Fe%@0Z6lYi5X4O<(_`>V37OJj(mjQF&JWa~&nN19V;Y_h=g` zv?5GFHZtodDXgt0X`lN6GU_!QnVbQW$}f2Xx&HvSW&R{yRO@!A{V6MvSDo>g93ei8 z*LZ!55Fy&prxl+j(b1LI#4o=!^Xgno*rkagGzWD?=RmY+iqMD=4k9ebAFh(G0H53K zO~3lV?E|=!dv~VA*+wU3&dCkL6~p^D_^mLJgujXV4NnkDy_4e1W^bX1{9vC_ydGO5X_9o>t61B`sd)>) z&7Vs-hq*l4+`7{{4ziOy03y}02KRR?F|$l#E_)sj9RIgaqrJ@Y7kQ6?1zUl4`Bbww zW|A9K|MB0(0pZN`)M`PHL@XVWcSHWArn8MNK6R?cQ7LaNokW`#y5`t;Xj`6#4av-m z)oQUWkDpJd({;-PqkG?exI9@-V=h6?uF)WLsRv^Mu6>e7=2>mt>_NNtCz=Wn1bmB~ z^*tw8wVXNi{tdEITgZ+w@T%{phObi(R|Wy4cDG-nQhEu4gBwuxOl|cn*kz~#_2*7m z`(LOL1cGbJ3#W+7K1e=tcV-mhb;Gh(`-dPG#dm@-8KayOm2UNBV6FFq`XT$ z1F}vr#JU*06)&#rI$reKd;j@8GylLR{NBa80W_<}}ktd@=?qEtoO3n5F9z>@y6 zJ2UecucA8S(e|ww{st(_u%}IUnb8-K{=JfWA@5OD;K8uX@)P-Ld;Uf=F*Ia`QVdQ_ zsp6I9teRBuxN)V9T-W?OgO=-i+Ghfq+9%)2wfu1tRV}>yLrjs2n13liR=E(HQ7{6OKgvjj=tim4D&22}u8X?yQ)_03E{#yn_cb z?u^L6_wduj<+C!FWhM8J<^)!&90#;UVaNZC1kG*oXF!L6b)O#*A8tCj=PZCN$dfji zP;oIph9;0*;U6szno;g_g5VU(a$Dj53}ZMy_x}!t3A)`FaR4Mwe>QkPc`A&x;*aS~ zTXuQd_zT%~nAelNU�o789Sw+8woQ7xcncBZXCFJ3ww!RS!rrL!V<^%E3rYOgL_2 zype^7K0RuQ-a{_C3EdkZvn#7P>Zg1>0S8yC;m_G?g1;%>WD&!;ddHe|Z+>uueDTj~{(%gZ;ugyeHqV$ir4 zUgdfhAeD4IYxZ_2nl;F1i@SOAH4MWjcjdPc;yfQ@dpcMoR6bj6wv}56wN16%EN)#f zYrkziIzg5V_Y|vLf)KFmo6~m@8u+P#{|wdX#(2E9TZw&TD%`0Svft%|CGa)mX?7>` z4`T6(^1UTuFs<8XW+zOC0%#K~ExvAQhlnahV@aVqMHv(@PW^e{(>zvV({D4C+UWLw zkQLHTlycz`v9Hua{)1$(hCM-Z)lu(zWCYKWxq4<>eGTb zM_m||ERiF@2NMC;GRw;bw~y6nVOL&AxX(z4P=qb(P5;+Uqr3+~q@IQ!Va1~oGQ&b3 zbM_)BwpZT#D1zz|R??%Y7`pD^4iP+;#gnG=kPd+;_;ejr_#N@BJSuSy>pM_0lgnco zZ6@dx4a9_p(rSOWirC`>2GG&y5O0schrFJ|t+d@a=@rT|&MlMP0A#gui?JzYYmGFt zEdCeBYzZ|0l6ZSZR+~fwbUMF!gEpUIVuyrTn!n{X{T5l){8QaGHsw|tEw^Ax9`qpJ z(UKcmjnW-=lpysRj>ckxHkKc_C>s4tMzYSP2aQT|>>~WUhh^ItE6eoW$x%fuC~)l8IC1(w zQQ$dO#KK9J^C!ACVzVPAx|R$~$bWQ=#+Rfy-=CEM-4XfZ+-5=`acFUEOP(``1EzSL zTp1=&5%VZP?1XaO8SMN^vlKx`VUE$5vb&)>>OPD^>N4_zd5z2elth1+lp}#-XkrkytpX)ugvIonh`PudR@HeW!V}}O`>`{B~<-GR_|;+ zdh@=KVqBUJt9{1)Fi&v#$zL{W_Y$iQir2%!o<5J1YHukB9rxiFNT6@)!zyub+8j!# z9O|0go(cnz&jxsw$3sI!1~25#R77(zY(SjR)6A?!^ZsmJwYT$V!)et%4MwP~-qMAJ zNWlob!P3?JytIG_|6O#h3jm;zSzw^;uuTd)*m#ZhVeV$b@1eUkMV2oX!(TtWQIL&SFeiA|s=S^IpD9wf z{&6d|$qYbz28(jhBOR=lu=qalV(^cMUe^1>*;N(KnEhESdl$Z(s4B5PZ`S+_M}l8X zjH%&*P}mq5`%Ze~f@M${Ga!u;L+&54vksDAnCmb3W(~l;h9Kj5Alp^{iY!l}y0D`v zFRR*5J6gu3+)$#A?1J&mw=BJ9PJ|EoOa02YbKcfH+kWL~D|M^j>|WVr?^Qj(ww95( z)*-REHzyrx>EXfIA$uKNV0dcQn(2;4faO#!M>br6|5B=e6alJzP3i_^46mz^j3~m6 z4GynU9yU1H6?usM9UgDfte)PBjf=^=ycUry7_n@?0tad*F3aHYd) zt0mUaK#OSLyVXD?HKTiTG{KavD5juonmur|Fv-+K`Ue?kQ*s!cyqH zi;|zOx$qj6O{5i#=TFTf+VR`G0h~24dp`efR@}rc0Hdi_&qp8=FmIiF%wcx<0q6v{-l9E9sEG@Y zoZCiAC5sfTzSt6}gzAt;R6jra7c0(bKPo7r^N!ou@#MkKnMeoP2qt-TjWo~;sn#Q3 zertrp@j4_IyN>vwN%ppt7L)Kt(ml{c!44i(d&%wf(Ji4r+9!-g`j@@rPeDwaqU#4i z8InZJ9i&z41xgQO|BJ2ubB5ZN_a|!kTEH-ztQq(U56^msgKAyBe7l**xrQ>;?X4%)pW1fh&3duH z<1|nun1FbUcwW1X9{ z&}I1jic@QGF;kS_;j2-iY;~0l@KzoCJB8W!tCZYrR^LHodS+%WP$dv`cg@&cVVtak zb4WNUZs~rdm3u@jf|I$K7#g~_{M7JIx%Xr8nD3PY+45p%@P>wlg*cx=Jj*84tRV2y z{1UdTlxP#<@T5Ty#&grG8Wj^)-hQ}d?k%;Iim5`#?TZHcR=SDq8OsoV(gXT}kwxjG z>*Ju`39pqUdjKAs@=6Sq;T;40@FW3fZr|F z+uV(@j0_F$_ug7@0{%&YHZbA4Zk&;fH@?fBBtPYye{76N0#jUL-Qo?^QvBNy?Ge5= zw%XxragGHr&6&)hB9mdN$Q!r{t|&YCF?Ut>6K*@~Y>OhfsEqLqL;gG;=~Lb{t)&vb zX7@T_ca?KA)Y@lf?RnMX*VT~IcR>28VW-*73hq#SW0P&+iSp^5jLxW zFYA2TnlhN)LADIsTlDr(Rh}77++LiN9ry*wK@UN2eREUjT0~73W#;;fIg+WxT9Dl9{%VzOL?f; zSObwPd7;hOYLXI=SFWt}+_2-y|5+8ROdUgNIPEG@?tH;kLor*@KBc=^=Gem4ur&^~XNPd&3{Y7A z-N$T)@?^A+5k{6k2v)I#UwQLmkaCOdx=Hj#2-tj+(3bsa$q%fF3sjeYS51~3qID!= zJd96RJM8t8nK*RXSySK-I!@waz`FG9JTVj4Skki11H;(Fok8|G2dX_bfZLMVxFHIl z>6IXYzmkrpO72y;#@mZLu5F-x@)UJX>}Q;j?tK;!PnS5AL3CxVM!qDPO*6V^Kx-z(*XBRUFIV!?r^(ic&cqgD&;$8a+z=|`-{W{iW zn`%;D-RBsDbF`BkK0W3jSMxx--gX1hn0*(#Op)4D}Z zXAYm_oKL!ov8+6k>WF2d&Rx^mtl)TXmC?Pq%{K(vfni-zDG!G6Y5*1AKpInLp#L=} zQR@~#qR>37fKx7B+&cJDlEvS=&o6S(t{Mro&Mn1$UNWZ+Hbm(UzEZT)c-?y`jg&!M z=wyvTWz%=>=72|whS>UE#CkM7h|)Om8_NHS#W^}HFLVxr82&>xOFZJ!?vgJK(UdRL zdH$J_IhDA3%yLHjpe6sSbudCmPV-=E<+!uKuPn6WMv-*y2{|dcs$8%UrGVF`e>1~l zPQBDprhg~=ZO!(<2Vt{O76A=Pnj7IeVI|R7X`W0Ks~DK(NTk+e>W{A2B1K;AC6kL7 z7Sd1r?|UIWg%t(aHk6osjU_A@IGlHxYc3Z{28UoO4hdkX0ns{zV^!Jituv6oE)I!Aqu1#`?K(T&x4S; z_}Bz9z4REA&%2pJsvantohm^- zJDmYPDaw(<8XeXd*^Di+{vSUCwzw@z!d%_VW+)Ayyf&k1988FrIOE*nqtt{JfjM_6 zY*8xp-?ICK`4vxoR|06za|0bmSL>Zmds!=rk*s5e0jCo6=0+qRz0)(SLX%A`Ujm>k6L9e~=6)7Q2*9e=#UrJ?Az+GaB+heMz)#DQ z1v>&CT19yx+g6gH%E zQK1*=I|O91PB!P1YyV*wY)I6EI~In9V09Arfyrx;oP`lN?p-=5+=k|-@D&wrUse<1 z$Gk2bCTG4EqS^7BKGhaz>Z6Y=F$p=Lw??hE-Q~ud%946yNDSaJf`Lc{FlFmMT;<&y z_g#GDGO?V%2XKIjq%iZjcQZu>8n3H8^*j zng-APRdcpNz{_Idh0#gDK<|EE-ul1RLNFh6o(2^I?JTj%SYA`y$3c zC16g~WXe~WToB%MFpN7A5c3Ocef~8sF&K-|5%L2+{Rx%RxxgUX{T})Ima39_YWrQS z=J#RMA4)Z=d;4D!YmtS~`j1*KCCah1(B9w=#tHuEx08WPb5@@Z?vnGI_tM2`O}EJ& zcd63Ae+@;BWHwWeg5LGO2Z+Hgr_Kn#v9B{*-;FGFc=kA2rPn(X;Tb12}DMcF=is2+hEZfbVNZi_~z?X>M#o5S(9yX&K_ZzHyQ?_tc5YX)a-!3C z-bvD9nZL76ZoCAF>`KrHzLn`sqXw~8ZP!evlQ`C?pgjgEPc~+m6|i6dGL?~}AC*2$ z#1f|TbHs#%e2lY^fkrgo#aOpR7!AoxSvRO#tGD?racq3C8R%A(R#`nbDtZs#12t3= z^BTAoG);v-2O#;#3%&V42NZ223`a}BR3X>N@u$i;l3xLT6@>0km%ux zOs&P|<{3KL5#zl@8sB1mKCk^F0p@w{;R41qBzD_t-p`ESlH$TVD}=*3dxdREUb7IH zl`uR_{yf4gne>qBZaT6&lIA6W&Ow(EnN(0wonj6sWm?J2ZgoSCigXDXZ9ajm2BM;t zr&mJAC+o_~Hh$*6h#6}I-U4!v1t>pTfKSy5BjvnfU9n$twc3$sM??)ix_|MXf%SB4 z#H~Z1-#7sieSl@QpCy300#4KXL8&$Q(zLpt8P1%}%#UfOBCrtQpQ_T2?k)2E=BTNb zHCu59*EZ-0NFva$6L*hVd$I-Tz-{C1@Kj25%m_+r5bT@Uq2`S(n3dlkOoNWfxh2)r ztw`dat6R|tOE!(Wv(@G3WuR*B1zANOW0u^{uGtcD6R{;FxLo+0H?SdYb*TEn_;R54 zxLQy|cpY^PqBOrvziEE4rMejfk>u6u1o5IIss}}}mJhoCl0?$4sF24-8>?SRGy!=l z9t%C8KTL@9_XA-|^Vl@mQtnEDnxi};B=WLr0io5k$=v>(;yNGPZXO7rH=U|H;TC;Adl?PC$#tKxJl4dhg7MO9*?Bau`#onml zX>G`cb_!E;8sJg3#pDsj&O1qH?-6ljFNqN^xSonDBdS*4wmxnF8*}NDsv4RPBUL?K zTQOMhOLF_g@c(_QQ4WEaBBVZOm;@8%EUB-VSwcJ(+Lso%EcZrcb8A9Z6rcBaq0 zmgJ5H!EUyBgHc_Y5*>MwtwQJI)#T4#$fgdXfYGBo)8qN?TfgEC>%OhXB(k zuqjm=8f?$wC^q);c zdJ|#m|Bj#VSh7_pavn^zrDxnOQR3O^H-Int@{la@*kCmGSPlN#Ks0s~WvXeW_xu@F zQH4QbirsnNpeEF)hX*N6yL)f{*{2V>9Ttsh8nCu%sTSGWCEkj%;S_~)zYx}7c?^88 z_=zQZq=cwy&7m^V3`4||&VqiP+^|sFF9J_oK@?8Jky1oowr>g?2bF*&M4NfO+6|`5>YcTM2by)&e0|6XU0>=%C2N9J!~K2 z>iq%~{lEnVDpS8QS1v_SX>h?4(t%sb*xy`_Y(wg6sVMC;rA_BD+xh~(9|3Xf8B+f= ztR)Xp3D#$eBBgs|pz;L3jaY4gl&40Gghz%clb^+s_ zAD9-_7*0E=i)+c7>e=|N=F=H@eSbHJl(T6{O```9#={9M5-*SY@kC5EME3czOGwBm znuYyh3;KAsv)(hJllmiQJCuE5qQ&*c7ZHURSP>Ib1B)onF9|%q!pfNUwK=2I= zy#)jl+wl=qt-cCIng#&O}^SQXz4B~W5#K2Pt^}_p$Y!_2M08YaW ziM1~i?#baC)14y-bK9Xew3*q(vU6A|uE47N{m?W|0>FvX!>t@8=GS7}vuQ6{0`Uqw z|7kyTu)rBYPhhYc4XxDoaWi?=3m*qbnM|_`N^segct&!YfYPEv-KnDdvR|sAc%We* z48Gr=y}kbG83|+LXMK)bIm-^smE0K(=JdKmum61%0C>g1=n*Y zqEwAr8xfq^jG`z6knzKtvBl!(^yRyIG;Icm-T;P6XMXwlesbPZ8O96Y@D0aQ0F z7e&a^hAzc|tZpmBDVq4aHYWK^rHo^6z@KjDQIaBNKX=3m)y_F`92|Tz9PgpOrcejs-h`GJ zb1efmHL-vsNn0aj?|PS2C@|)w>4Q3~HCgiLcH$x*IYt`^oGcht0B_(Kr5H5&_PE2$ zeq2d{HxXWNLC?t1WFkP`+JGCY4PYYD$2Vx@+Fp2*ZrYsHpB~&cF$EVv^^DcRs z-8T-MHAbLBZ3=qZAlA>sKB!xJLA|-n^6@YN&dpBhd6QlhHfl4M`;o-?_KTmJShSBb zoe+jKbVOMVnyV6Y>zuAk+;C7*NcJkMmjGG9wk|V+eaM1UpR;l|5{w@Vp(_En` zsB*Z>e6TZFm7k#i{NrFdfA>j!&^1+RGBJ6FPQ=^DI;BLXBeTA{{`}dS=A|*zvw%v1 zufLtx{5h#Hw);vW17R{X!`$=21Y`o~E~Di&aO-`YO2j~6X!GIVrI~4f)yNWjQ{BMhe5_q0le^2~n z4?`-5-ZBA)C8cBYaY!%2wC-u!nQWz(cq=(JB1{>GXi?Lo{Y%VkLb{GWgiaA5=D}rm zGD zE-Ja*5y)ch%cg1*Fk_kPz{Q%qjg)ZH(^MNHpHWm+Pq#g0F$DMeo#<@w&Rw;f(e+|W zDr!UZr|O_v9^TBpEjvTtDhGH*D!ZZPatRl38k@@r_iUSiR1!|Wr(hK4ygVfjG-EHj zf4DA^7^83VF2dKM`t6c0p++zGW11)#{#cGJ;7dFlPHL|1J^gTv!C=ooV*3HBq#!LE z9cMu)qZo8&5a{)?-ElI39Lj8al>%#wh*&hp%%)D0My=O52jxt944qj}vqk_&hS&acvX^Od#I) z6BduDkI>YPd7P8cYJ-`#(o(&W>8x-hVKea0mDYo}imh=YNaNEUZP@%b;KpH#V#XM@ zrpnM>Xi=gp;mGz>uJ%^Tau;qBOdp)8ZyG9wF3amKBsJj;R>G_}sMoxEu>BXqiqMrn z`8e@|3=wZr1vN%+~+4- zZ_v4%4TG_g@J~^I8RxkIrpMu@!W*Ydtqv}i=%D6D8#f|N2e%^=e_QicJn7^+(=aSK zE;3yWPaDwRZO}DHhS+MAiJ40mbgE&`ns4d%?di|9N&6`+^&y1k8T|w4Z%!)pHz+!SlV*yzZUB9 z)i!+R`>s+0^jZKKnS}sd#>GYq)_o%VwzIWo!7rE!UTGn`4^jzU+6pGl2&|MAKxxtX zT~hBOra6$~BG+>;=Axopw(5X$;IXbD(;~qs7YcQ0VO3y_p{<#m2@~gU18tKM`5Njl zLe4=SYlGL$Y>?7z7#IsI=_0fN<=6)IYC6y40kZrVK*e-x6I~N49-nY6t6BJQ zz>L+qP|D6iPNlxDmQ^v|ADx%+1=LuF*gTU|o?_S8pb0OVT2Lt-%p?Fv^#x}ue@=$u z_Ok8z7c||JK5j@Jfh6SOVZoR)o(6fUz44`Gp|pGed&#T48un`)`9|V>DnPYCgRTX{V|q06I;9mS?l76ab=N|#>mS* zlohi{sH>IG?~uL-{mgc_qjcqD%@vfPJ-s=eNt-B?-0IJe^?Qw093OueDGgZ&Uxx_g zeD6^qo9T=PwGo%kiIlC~y1nJnv@RwbNz~3lq*HL+Y*a?0d%NS82b1X4_2V%*PP!bx@h2CjihR&h8!*lGL9RN6zVbZj4@>wmnyZVN z;&^ui?I>-(tB(^q8ex6b+BKcQ^RbSl=3>0cXFn*CCy#+$Z-l*E9mFzhl*v7WnGI#(>cZgi*?is zOk<(Id;JnjV4p5R)B=T$7As=3Z%>w1fdRf&XBv-4Z`)b_GX9KEQ~AEGSP6Gc<$=X3 z@H=P1vpGsL3%f_sif-(M_oa79 zHWyqIJ2ryqRjLmIZGya`rlv{yK^e*Aj#H=%t2|DM9l1D2dxFMm+t;$f-|PCE=ympOil0rqMEC3h%8NKS=}feh9GyTYYp(TrN9sC4g?7?kP|XZ$u96OQVt1I zUN9Qsa7&=vfbVu>?N?m~=q)Xth*A#D>@8yUs=giU*{Igk^NFr|sYlg>F=rO+^skkM z@a*<@K&#F17n+iGYLIY;UO@xU@z4{Q&^Moc6(3>7Q>Wd%J#Ibuu9Ykxjt=OB^QXU{K zYd{@QvqcfvKZnDs4-$(yR%~h8GT+@2Q{25^n0#mSYe?ZN??z~ z(QYmYL|a+TP5ow!yX9uaW@MwA{kjG#j509N3jHisKfz;Dt6bxSD^@chQHC}noNUPRH1)$DI7U-`EJB-jj zTOH_mpP0&f5d$M6H&l~yKZ1k;1Ds$eK$v|hYiOs353P~+HXD9^FjV=~I(nXY6YDFH zlfjZTIugQ>_U8Mfx2g6-F-;HJfJfTB#!y`*|1Vstu@lnX6qjMzl!SZo5!(!wvud*E z0KK^FkEnPzoSH+1OBRQTsD`MbLQYlx)yM3J6o}W3sdQ3^zDFRQ#W6kA+Jz^8L(Ou_ za0B+vw%3+%YzA^C9z(%9jZL>J@43>AXv9QIAFC`YMDkSto=BWH$k_%1Gx5#~Mlv6@ zAZjIsc|6azzX@|mGF^2Fs@Mtzxqk7=1L5${#7C~doYH07*s}On9zSViS1oNtA(Ymj z?(hVMo{zsnIYdXN-&v`F5=Ga5%&C5`n9{)0Fs9_rEoIcaufRFXTZMC*gOYoKusk=P zbUZ5yFUSKf>a+q$bh$WZXEZ$(4ge8jhRA-A0Qk6*ve3sdNOvqTxJM@>F49>e@n1U* z>gGUy0?G;F_H?H?2!?Gw6$Fqgh&33#w|@z80&`LU3EZ2Z>Vb2H-<>vMGYPz8{qnOWVZuLtI_}ek5(qLHMy^J^WH4? zcK>G`uG1lEXtoiJRZnPj(uKMLSB>ve!=u1{@>{IrD~-TK7p0Y0Lt`)n|mPh`=hzH!72dCPCls zSri7_`S@R`t&n#x7+0VhVb?xf9`PXI#@Q-|Lj{z-qb=5Nv?Hn7>=fAO9>tp2-$&hW zQS@??srR>GKt#Eor|cpFc07W5_v=*B@gmE(zR8if{VlIF>VXzo_F&vKS1t937dWHspg5gqP#Yc#GhAfdsu0;?6>7&YVO@?;L^Z-1SSe}*mOSX;PfAq9V z+@uNuZ|H?Q0Q&RmWJcdKEXL+8e;XZ1(hK1Gxb;i#d?xxAQ7I;Nt4|=J$wxnuKwjQ? zDh=DHk7>WsBO_5%XT&2Jo}Ko}jTH9)a?wF|a9Go#+F>qeRLA2DvD(75V?aD*HFm_q zYmSVW>ExDXLR$tNjt*W)S}`xeEsl@^JDpJqFyCr3S(#wm+YhI=;?vu7I2o2!nAh9~ zX6X2+zer<9aU=3xV_>}Ec+BX}wNP>kbPtdvC6##~i$IZCTI#Sr-L~&qtstRP>UW<)St783j zbtR@>MDJcjgXS*LH}g9wqQ8_WBsNF8dHEMwu7=FR)XR@o7O&Rtv}(%jN3M0^?4?T> zUQ%Yq(#JYc@fY3Wjte|;49AJ#BPZmvX>8>k|M2r-i1KBF?z(xWYZyaCojc|!hz;-s zV4ZPh2!r{0-R@0Sqc9#+%`-4Kb6(Q?s&x}`<6ISrK0!&(p6$BnyubNF-R&_3GOBz$ zGMfg*?)b-(EUNZ*FUT>Da&&11Hs!A0Y`mX#uw@3K@%R#O=LF`K81CPH(zI$G9AAF+-0k z$rVIe0w6L`VQUIhaj2JM^=P1c1~wA1&yf$K%qV1=V_EId77!ik#uCLMor`gNbZaN0M|u3B6rb$l&PevdgBy;Y7X{h5B5Zih5A2mIzsp{DgY5DW z-(Lza7V%)Nvj4^78t_*ZpP00QA@NGza z=k7$LZRJZhH9!W5_z9_EFfY*`_jF~h&49=w3>G94rvndkx)V1xIP7@(v_L=i?OqP$ z!+O`u*zOu}P4xMqAB|Eu^bI7kz!#!oEu^*!n|@z-Wp-6POFu1OI;Z zU1!45FfPomhQlJ6QfH(w?J=GZ=is zgYZ0LS)MNeeMvVHI=KRv!Jf`A|Dr}P!AABj0Uz_>cH@T#x`Y_$2FTdw%|Wr|uBks? zrNsjCMSriWH;j?fCZrHDt+HHT_yDv(Lnh|VP4hJpA5fKNT*0BUn%v0EBa;~IUC8X) zD<*9hptMHZ938S~9y_g^`X!3YshaP9pE?lqA*jljPTOEj%5ggfzl%jhRn(ER3-p&n zG9D|3+2{&*Camki8)l=z`g{?gZZIl#@EmJ~Ev#ov)>}L?Ey>`60#*d|>VSRz0nqni z^Ay|sz}-s&k2(L-afQVV{wF@^js2jMJic)^$UW0J=a#bx)UjGBo*xmxBJe00O&(F) z*(La4>;+Rnk#Wovi;$*tpvdir1;xPz+Y>`h&mH}wAfPC;bPRrzrWn$2nd#_8mZ{lW z^k!)L?sWH%zOl3>nw50IrlyGeUjO9!^p}nIA7@YfD^PE4pm65~FBrK4oJ#m@dV6e? zec0y@aUi65vWDUMZ^D1DtCbibK?wlmUAYAA%lq_-2zM)au*I4=w#u$K3jc_bOeVwC zZd=GeiYoE*Q9E~7as@A}t=qrclh)Zt_W}g-lKc;?pCU6kmy(%*=#&b#T>N3ArA@)!gst!nE+CNCu}8YYGqc_>MQI2kWm zt1E)jyOR3W;VvpNP^83TxtFDxGi-}`H*S{s!$El$`OA@*3Hb&q!ljQ+oxyiUhnb?& zRFzEkLKT$}`SSgz>H^jzE~+YrYVjOp%hMjpg=ylP?s<|KurX?i zF2o?}iQD$M`LXUyGf7JGV_yg|qN}gO*H?|Q**kzF#hR?FM&LgrgNk^^UDGQy!z7u< zi(3||Ho;b zWb|*LSqM;@)i2G)MS)3Xuy2drU|q>gXHH{*;@1cze4^AiC5~Lzr7j1%Vn&A1g0~l<4pH(b8ORQCH|E1!#v6# zOo*|may7}xUV@($L<^&t7M57W>f? z`@5$6ZS*t`F0-$HzE)on(ioI;K&3TuqtDR{57jO;IdbZi(VjAThleI(tskx;vBgLF zz+Ruqo+3c=4{R8Lf?#PGc<_GgeoeRqe@Oc3QhgK? z_31~?#nb$DlFafu<3fJ`C3Mf9d@jFLEgcAzc;*L(-XX{WwpxlW&J@wZ_r!yNkWW)O zlYefnF;FM%N9B-)v`HcdyIrl=fL)0J8N?gZz!3Bw9fi9tau*4Gg)s*zrl%DR2|p_r zVmxW@vvK#yqe&5LwzH-m7m|kw%6H!uSSS9YkuEhl^vSd-neOP^U+67-laNv&xUpyN zh?whi1sFz$`%-u}?J^l3{6s4gQy+?HjlvaKKOuw^s1jT6GV-JsMezglIfI)*Mi@xn zqSFr@P1?SS;D=un$7wZb7U1=@nPJj&gT;pJ=|J7r#SMz>zwrkB>jG+GXkh7zLCFvQ zmFZII9XNfB+$kEc7pxwTwan>hs2zJRh&7M=@jQ6hZVi4`?$v0yj=@|AK5C+RI=AyQ zf6}GpSz%K8WyQK6vZ^tHTI=qJHL&C40YjWy3h)!{H|}4~ z^qlFHVYRLxdU0fh7lm#)2wyvyC)W(>mNSSdzLCLePa59Rd~x%3xxX6#RI#D%lza_O zQ0|-4QZYg2qk5*T@xy~JieY~Zx+|9!9OymJt!Dt)Kg6G#XWFM3hl-Y~<4^!3dB6eo zbsD{4QTyjua5IT1h~Gr>eNz$73fY-ED+nuRStXVkB~mnBeF4QZ-=Q^12JqaLNpen*$DAJ*%pP(P%!Pn+Ahb!Rez>tV!GE@4MALKe<(4408RD8=U6b&b zf*KlKOGuVN^u+a{i{z-Hu1GKlSkAbmxhOCkIOfBcd3M1`CeOpdP$QQ z))!#Sj+*w4X*7dit*Hr4;d-lRqkF5LROnhv4W7?6&Ua+qqt0)GI#&$;o0P*Z$zMe`;n0c|+rGBOn+pj#}`-hl6OvjR%Jy|8X9i!>&bV?Xok_5#IAvN=tc@e7U z-rWWVrv64ez^G^Ut3X1Z4{}4%`zqV1U_}S%=c&=_vreI0y-@siJ;w5*Jr8zZ;fSx~ zM<5_ezzzeMXuuZ{BO$U^xV`6D%7iGy2nz#k)uu=)GzHEo{kKt zW2gV@z$-QDO>WQCaimt6k^@bj+4fxz>lJf#ZqHS{RSaR;>`F(B1uIl2(^) zVk}j}n?o}l z)=ere^Rem%aE}#g3wF8yM}DU&#w<&=-u!nvQD`2O-HElI#dug>CBbbYZ~A?$idvY9 zi^BeP=<`Ko^A@tyOmBeYZ*>5XsXs#rRTcb_RUO%5_$`HuXWREROq|qva z1zpKGTbOYA8Hj5cZgK}Nmh1sJ&$i`wk%oJJ>phGo0)o)iD4Xjc5hx7Ct2HZPDET{d z)#^;5Thg(A|laCry)Lco! zF)*aP!4mSBo%coW?~)xBxmC6qcia$9HZ$S1H|xsJA*$78P_kd2JCrk5S#Vr)Yt-FG z4lVmgAhswZ);v&ejDi1$>u50nht%`md05(p2MSo=lzXzAq3t$J?TxsFJ-%@A<&z(I z5C5My_NiroDjgYz-SHnz3&&NIo^HNdP1qu`BTa$I$t8H0XMH`2OijuFYRRly41Xn^ z5-j5fvW*0EQUS9)OU6DbRzYSPV2q<>JW7sTph@Xchzzw>3NZWPiAEK4QhJsEVL{zrNnuoF{Mabp`2 z`=C``fI;6cgcC9-*Tm__ZNG)~%FlS0ulqrrg4>)Zm`97qC$M`j;*bf=I`kS?M7X1O z&bX_X>t27LmK+ThIDTmgF)LjP)V3Eu4)uFG_&9_!V=9Et*c71#e8fX;J}1nh2n^yNomzd7% zk9f3$TUh)W@S{S4H{I{?@FB3FD?CYE5FSTWG)fQNhOR1FQ$f zYb0Sa)@Dgwu#IgjOI`%tC2wG`$I{pyEUD$0 zkylJ4%o2#%0|ba41}AI*Lf8T!31$tD5b$FONx%;Rya0iaygb5#yukOXy4|zLG9lmh zzH|QXod4KUeXDNWx^?T;t-EyhXwj*c2~7y$!1s$Ugm@5F`pjndJ1@gxH3q03vpR>8voD7g(yp-|9mPW#Da`c4aw+^B=EZL0w9mu zj&@{zLPD%>h$rG*AhK?6AVK!I72k}{>{O#Oh{s5h4ytg9I~EG@^fn>fz;|VsGl_N% z9;0j~d5pRnhIiCdsoEY+fI!{D1WtgU*#u620I!oAoB+XT6F30^`c-mp0tEDlByeJk z8ZH*XQ-kYlXpQUcT$_OtAmrHuPJrOG37h~S-zIPZ1o()ogcBh6Yyu}h@Y@7VfDo_= zoB*NFCU63TBAdVo5P~*=6Cj`|vRY1nP+}7}0m3Moz=@M(tJOq3+8%DS3^3Z};RFhm z+5}F30LPW}Z~}yKo4^SW#@GZ-fKXu*H~~V)CU63TN}Irm(ng0^2M2*K_!7|G<4Hhe zPmZhDgjyb4pbTB0f=73SQL!gCf!aKIY8Z8R5|HaLRJRFn9^I^BSPd9(9P#LNx^5zb zcwX~4YJ`GbQV{_bE*BnDDc}rakyqobpsyF-+?qh6Dk8{(EBeAKV5vH#rlL6x_4>o( zz`VM`v)U6r9w~i-u7|@&gvZ-h4Pmta6@?RA6@}qCBtxHnO^7fI?f$~~ho`6NQ_VBLSG=a8`Bc?hi{xn@NlFv+H94xe5n1(*07?3R4RYXYvIq;Y$TgFaVy5=r#A zWG%9i$sh&8QvkzrPfZ;Rr=0B+Bda&1xR?Q8# zZgFivV~MimH1y%%NvmreuHw~O0?uH-oh88y32vWzi_h8op3fNzc#sPpvE+M@>+yLi zn)Njqo!0!i4*t~;{Pdht0T;|UEf&yydPR4m!>8A(72N^7qFFX#8tG5{?bG)yfn$cJ zQ`4v|?l860=U_gA8(MRT?IhWzV#|(N!}fwtX#!qBbEhxyBQ(*YYkOt_*VR38Q`XBVJ$5kKY-U*ZXie;)B$ z4SF)0e{^^Tj6$&+M#HF~F>?vZV-QYTFDsf7hOiGrToBLP>P?lRGPau%Y*YlbDyAxbL*Vx*K;j%yyvlhSk( z2!9w+dhSV5kTUegA!2@4=Ow)1qUz zhzCLYDZcDvz-gV8#1+HM7fLyTC)KUF4(`-E!ye8Kt)#>n?ao@CDp(nL<#n+`pw zqov%HIl;ywM}j^l8swDS!R4SG!tpMgt_QbsyAiE*o>s;Vdwi@T&B2cR3mChf0$ z8at?`)(!bCa~+DRdQeMM^PbaO4_dC*X_yft3|c&Rl1?-bu1ax}miAbc$#p9yKp1Zm zH~|8NljPt82$-KGffFFq*#u62fF+#d-~`$8RoK@@I)}SZalM{E5cTX52rFm8J7}G! zdo&Ki<8(E=4XBCGffeZlKsA26ibcy7qWUwaC#9%`X=->ov0?e2DttQFg5e$_m!!$z z9Ylb}5I>OO$Z>_E(5%iYYvz@;Uc1Z{zkur6n2{BvMYmo%#TEa?@T?Mm;E7*~ zY?qu(C{`vm1MHIG%~23hJTcd<3>^<`ex1@L*I;exi;bWeL$Qi^Y2Gp5wagRlMLPJo zV!~UqXtcyn5&DoOk4q6uB8mKS*PZC|H?rDM)RozV&Eyznr z^9PX6(vReM;^ms?*AwVM&n~$)A-R($i#)iXGEUWsxqG20)ir=TjAfrxv_2>PSCme` zM&xkZi1=|1M40&5fMJ-$W8Q_z#ul0n;$l7ofO#liFE;NX9A?4mEjpa0YiCq zjdRqgpN}rY+>=TPIrqR8LKKQq*1?gWAE#r&L%Py>j>a!q4O^uB&ZD!3m4>%Mbe$Tk z(b=smyhx4Tf!d`LO9ur@am_q6{sQO>!U-r#ls^(B*NLVvWtSSSA_Ri<`aCs0$wunb z;+h~#2AgT(YFvv*CoR657?NxRwna|uR_rOs6uCx*QuW6f@wH%;D%J;$`1%x9hb0yH zWWA#}@5pScbY|H?o0gVPN4$m7{5h`reMj_hN3?NAM6kvUB`GG-XWu@dNt+^lsnBej z-iJJldDwI#v|y0chN+i=A>E8!DOKzHjrh0I*ajp1L>lWf;;*H#c}D!RG&a?Um*}bH z*BJ5UG*)KB7o;(-5${f6WOcid)3sP?OH=(Pe~l=s8C!<=_mOcfxfX<^zBOr$Ckm zc}{pjVU3H|gfx1Z=E^otQRBaZ%A>*<^m@&7HU1f}3b#a&>350#(Gr87JH^G&331z} z`h{Qdt9~uK8wKlVf$t8VgXEE|0f)~qU?3_5oJiC|0c?Mr^-FzvT^p8Z7*rmq^Arn< z*P#*u$FQljhR;zPUO+Xuxi81;^O>;&ErA zF30Ekzk(qFBYDOSQchv`Y!JrgEOYId4^(%=U!jsg58~|S`g1lj(!ZqiHfnTM31@s4 zc;km;f#>Z4QZBR$4}!F8>S>66>Lsz_iDhc=x_C{FJz(l`bNS`VBNvbzc{sm*T3+L+@$fuYsq&2O^NUFgw#BGndHB<=L4|nb|Be zSEn<*5DWELZlTOQBb}=j=i*Q$&kYSv>cQyMmP%jnJFJA;DHCj(Ui_&H_G0oKI)^)eD}CaP zxin9l3<2?_sU+=n^mu+=D(i%Fa!)$>-E`9BP4WIFoxC(ZMQtcZCI8GxcKN4$MCD}E zpJKQml|-y_ihTG4!a3H0+@dZ=om&gbV}lh{ z`%R2lY$4BZ#Cp5oji#fcWEunVa?4l=Zc2<9FU2KF%4 z9LF6A8_~)k4;P9D0oVv)QDYEN+035-c$FWUh@>9jdn7ezGO{P%CWVRi&u9#RPE&Jh6`C{ z`K41}b;WC)_&J3b?J2#77r^o-qcaQi3}e=-g*EZlP?{b8Y8yD<(DrdM+kU@|(P1 zz~M57z#Zh1CL?}a5gN4=St?jAz}0ZYmlACmrTNgz#XD*}zKh5-^yw@${%sqJ--T2F zTXUIbIOTYs>Xfe8XsAw~5&k-hn}*WyBj8s-Y6Bvx_8CSnSRDQicxtN+>A=U}3LgZM z&q!dR!{Gx?2{0-=0gn+plXi%@F_ur$0|mZ<;?-;csl5@O8nhZ(7|7Am#bFgsz3c4R zxYXuC9N{KnohOic_7rr7FV{RDSY3Vs!&}#A52FWiYF!CzUy<JY&f#&qZL<(vC(3HW_JpFimHTW2LWD)iy-z(-p-oRYDV87|rF#}z{x zM2*_;CDf#hmY#tepYBe(4G^Qam>r@x;CTJp7^g>fzY)KQB$9_)ek|S6j%Rl5@t25= zs`EMOO01?kN^qQ*Zh37`>Ue63EMpPRO=)1nZw3RIRA-_=r@1<>ky<8U4FEmw0l>Hx zFW{PsD}9KL=ptT2B8+iQ?V%5?LouRheT}%u^Npp)1E@xxUM8?N@a$6g{5RLH9u*)8 zbM(>S%fOR!q=ZkOE=Ssm@HiAd1DIUH!K+m*176`a7|Z$EsphYzw86@ z8IDsb?Tf9oe;A`h$67b&IYQe6>+UphOa{PIW}@NkX#kFB{4X46=RaF;cGy}ru1g;yX7sUZ-K%d=PqipRR0{gx|Q9A zY)?i+*ZunN4xpE?ec^wPTgA*J< zPwghqQq%3a{pR(^%%wBOOJbuMMyv6QpfOnDPvOdkA#D8GMx*39?2a&wJoOn|j$0BD;#vhgQyQ$@@6mK~Kg1R&SYU7hhYm9!w^%w% zFt@hOWn8B@%zptFoMSff+}s&y{oJw>af>w9a9t8>{-rH~+$;womO%tLf+Z&4O!xN= z$U}eo{$Ypv(96Z)8z3=N&uuklBo2TuHhveRm^UIhZg2{wx|#;80lj0vjIUmB{b+OgitzL`U%*=LlpRSecKwJ?d^Us32A#z3J(XI6motU2piTnr- zC(f3I#`2wcZFNRbo|(}cD2)3iJiO)o*x#Y$)#_c8?;CZa(Nv;{k7N7kvGUVD3 z+0Fqtic(jI;+*oiFl56RJ9=#sNGH(F43B8k9fwsU29aJ@3Xv=-;P$)2KZYzmF*bjK z6cqd^F4H>@AdgJNO34KZ4C8rCuM5908M4BU0E;h&6)TQ244R}8qQFDAo`Cj$|$Ul7XqbWgyXhg;$jpJINj!9BEltndWc$X{wwe!B{&~+!Litu znVoCh&wE4^Ja6C6yInN>R;E{~8QvU*)oO7c$BI!1U}7BE$$SYF)EB9!O$?4QUj}9w zq_!@E#>~bO7q5UAe-|y52a!%!#q9NHRTej?D+WtgfHgMfpl^;JVQgkPmo+S5avGM1 z2!$?dSjwv;yD}QW!!mE`O{mT-2PI6%Y&;wdYf$2Rm5CC^2<1VE{qdI#N^CLYpe#a) zi~DpMl((aE#?>|>mq#VWVcl44t8bxESq7PMR2qIGV^sbO?HT9J7?mD(o$i)h=&TE2 z)AK8E9J6HRLvygFy+7$hvuXSou&oDI`p|eN$Ct*=2^n-659m)3w#LH;DW9kD;22|% zj_mQE*{+%6N;zh3z7~EJ71p~|2aoz%uj&Bp*Pxld0m#$Bzr`is@H@hO335cN@`{!fR-iGMA945Jkwm z6!JUGp?33xM-zkm70nwj^pv3Qy4xdIM@m$usKzRA^9wnrt_mQ+E z{ejY!qz@=GfVJ6t=%w)ya~eZ1y4(?hEx{$Ly^t4_Mf?WTe8nKF@X+EMMh@U6rb z;>3&iBBU}MZKV5>{Oktl7sfXSUj%Kj7GH>GKDaVF6y)P`D;+W8ql@o(E6a3oQa-_J z@@_887hB<$nd-OBZ@Eoi9J#a!lmp@`@qAMroMR?07JD%V9Xx8gs8w(#6X)tt1g``1i?NR=2j187i-Z&nW1>$AY-h$CeW3)gVV9o{+W9*Uu z{D?8cXkaIaA2YU=D#x7v2 zRUBgMQO4$q#~8yZ0p;e2C-7`~f%r|n5Z@K^#Z!zO0d^a(XPC2*Ip>RC2(7X}OxCE} z0`UU+Y_0JYU>n1CbxMD%5qy%=s~p7h zNAM_OfYU1&Y6j(g-aXfu;GFE}TKo z|D7rKGn}uFGL{XtRlX&b4R+udec9jz40l%;M#tdi>RX~?@K0{iZHdc3*-bjZi7t}k zaS#kU%K^^?ec9j-(Z*$icQE`HK)iW0x)M;&8w+XQEF@{a23$6HeAQd<Fv8xWF>>4s1I)i=w~MNw5gpu4m+l@5AfRf{guf2f>}T$#><-jcVl zqv==Y89~fSrvUB;To6L1it~-#Rjbgtr51K^6~>xaV`0mXhqomxY%TIsai)dME?osr ziCfs3QtXh$ZVQ{Ht-`bLdo8R*D*(37!tNNg3N!RKE$p#T1;F-O*w;g=(5CNN*fki} zy12{2UJtCog9Q&**vEkaV2? zm5KQlw!QdF93(BVu#1XKVDvr;{6#E*?~bu7aW1!gjChIj_FC9$j9qEGIr{71e8a*X zW$bMW`&Y)^W$f~jX{FDDb2V1BII9pV#tax^M9El*EiM@_D#Q#6`(*TPBP5a*c1yuy zYL&Rd!gg0arXDBWwy@?gL&i8!h7~i(?5y06xp1L{bpsnO&a$vQxzCFlu{VW%9Zv%6 zOJPGstr&N_loH9k#HbfbEUc~iGtns4F?PAQe)Kg)lh|%yua3IGm?*wxVXtUkh{@vX zR=LKUn~llB7*8@U7iQI6#tCAzg*~eh_Du_WS-lt7p<2o58S|JiQ>?9%nA`WPF!oI~Q%+yb#k^jp|Bs{d{*7H6d})xAWN(c}%zsfZKH#F-Yh9+6?0ILpG` zM=V$-F0rt8G5VK@yDjWHWA>@bL_aO8AmuiU{^g>vSz?Dv4fk@f!@^#y^13^PgEl$f zJXBodUMYGk>>Z4%)nb>09gq0AT3l#h8xb{DXSH^<_!j3~E@l;$x>t*(lSt;}!llf{%~|zr z7Uy!_mEv)Cr+c&5hiyEKfEk|s*h?C-B=)_W*F~?WvoMk4S52{&vCG9DJ!{=t#jO_h zNcjeLLcD5WZj@BgwZ0go6B~)_lP4B<1sxb{>s?-hzxt(gTgU~ zI0?JNy;tmI>?xy9JE&bCF0-(cF+W@&_FLGem`N@Ww_DiEJi>lxVGsB|5EqCiY^;c| z!xr{<(JkQoHw*h=Xr1`F_`t$`7E*wHW?{cV-i5-|N}4@oyo*y9 z+DF&~3tQ&DOSwqQvam;ew`lvsLJJ$vZdNW9XIWTV-UZ5K;s9e5Bd>E`DPEJ9@mS>n z_cz7c7IwJuI$$3%_V3D2=oalNkw+VO^q+IocimTuvK01x_w^!oF6F_Os(<9ZQIyS> z*e#x?+&7CloH9_}#_Ctx-xF;XR_1@*eTTT!!i?&--FJ#Q+VX?*7SG4-dqf=$E`V|W z{g9Ga3+W}_Qm}txY;VC+d6SDgo)qT%xU#_Wke%mzqyoE8#;Dv<)y7cH`Dt#@BlAd# zR}&8I#17U@H~~mG~Xo8&$33x z(_$94Z?ABnMNbdQi&=ReVy!kj?@}vo_Xy?gxAH1R$a~t#TQEZ2%U0eQocB8mbNi-w zo))DGsTnj@bn&dHW^70(Vn}&b)G@YK5a-WDG=uZGEY9b$+V@M*YnA(svQPb`*ll56 z_3y^>;zA1>tL{@@5Z_`(EY2}vpPI&Q1}4vpuF0npq5m!L4_I+2LPB?G zK>^mvD; z`{g*)tBA2ag3ofApelaNZCu2yAgGEJg~TJ%<8i!>ogV5{MYl%jJf`H8tDwA6qC%_u z92Hv497Vs*@JR{r0KwY^+3SY+biiWa$PrvNPZ?~Dc5)b+y5i9TEo7V zc!pCP;@M;L!b}{Bt70+RQ?_m$>r8Y_jNuxOrpSJm{MB4mw&+>59_2d3@i@M9inqA$ zzART4mvc)$6nM^hBoUlD()Bq-B1^kGc7#l%ttJ5h?#qX0eFS4_nD zK@(t+n8pw%ZJ@L>T*hz>!wAC|!>tT=GQ1E_7dHZq#+enReJV*91$exu1k}ZNKt(h$ zeTaE(WB3CLuEy&rKM=pFAh@$&s(46D$U8|q%DF@0s@!(bjThQzZ4 ztHd(32&n;Di#& z4KPe#zZX##GXF>F#Yk6{P^r_n>;{y6L>m2pFzSHkB;=eV*mA~*cyU|t9iL) z%BSK(tx~yMy&(5>ajiP7aGdgx`f$M%#jQ-po3Hp3vhbs-Sw*m=YLW6N+vHL8adnaM zjM`o`q#Ra%lD|%jS7>ebsCsqjrAj4AU8{^&$dcm~S^-un)BThtdyZFVy?CuU1#K*Z zRUZR}NG+wy(tB)07g zhHKP=MxHuKquNJl|5fz^HKHbSA7nW{24za#W9kg(`5a0Syj-2{dr*CoJ>*TX1y&v6 zx`q^5kw2rHkJ{I$PgSfEZ6Z|u8TfC=DO1*{FXCA3a`oyGr?y7j6#B6`UfZM^+Ia1k zWnS$)^kyOGp^6HviQ7W`(yWbFXbpb3dRt+cLYAQxbr#IfMroInEd$&S*rI)2c^a3E z0BRMR0DtZq0DP!okG4}S&pQ|CbB!OPMb{fwYuBp3topXr#`?F3UD{{rc<4`kMEZ|c zXg@Mup?%1Bh4vrg720kg~t* zVQnF5`2?PJqOVNp`ytx3Sa_(Jsk9)o~kJsZ)Gfu}HeD_=YrDjIj&`$3I5b^qc+C#G-R#~{nGKK zvNiBq$9Uz#;G2$zv}dc{1Lxa5=%8FW#^JnHdC9j5Jx*s=3&l|WLA3YG{Pz{Aai;TH zb!qN=r(3-U=K*f?-D2l6+MN}vor*duHv%}V@V5@?@y*V|+P%3KD21?3k2tKY^e@8b zkm*^tA9Eb1+o2oclDa+LbS_hff0;s@%M{{S#<>P~kJk;H^x)}AJR#GhtKvL72H?eh zZwe^;#C%XL2E`DUiG`qiQ!E4JD(3l?SgCvQ-0}^eKPa}l4BUk{3-FK_!pk_n5a$EF zAg%{|N!$+lYvON!Z>q=ZelbcrUJr@gsJD_~15Q!T^)%qD@nXPIaR*?vxF4`qd;~a= z;fdm7q+3NnP6N(J+5tO6H{faF7Qim?6TmIvmpQXpW(&hsJk>ZacRi;g3=kF_5_~LIDAbk^!`TeiGaO_%#P9&a z8yOyA_$b3S87eAEV2Jk$A#FCp7KZB?Mi_Qk@Jf-B*QH)BCIcP>{~*(c81A(o91roYMXEel>L zp3QrUdER24_tbBoUZGKo6owkZ5W`A_)eL7dY+=~Sa6Q8a!!Cw{42Kx*Wq5$$jSLSm zJjC!(hHo%@lc8|14h%JhA%>LLNgQ3t#j$8j8ygkI}@kmd~oz3ZXq-W-?=X8wegPcCV@DRf{7z!832{D|_ za6Q8a!$F1z7#@<89O6H~@DRf{7>Zn$!*Djk^$Z6Y9$;vB)) zgX>;=&qMkf_+E^>OYyA}r-_|dxji5rM)Y|S`~O#Q?{bE+Tsc*FKzT}WsO9PjYMZ)D zJyqSHZd7-wXJeMVU42@83A1XO)~kI(yF+_kJJ0bqhu1mYsbcNw#JwWiQNx|4Vys%n z;7)WU?yekRbE~-2dn$_3{Nkm^jwYLQ=2Zx}TlCzu?&b+{f}E9l$^AssQPi zNQ#iAyPqn0vKZ+SK%5oepMpC#WKLlF!QQ716=`lg`hjdSBf>@{3al+4^Bh+YCu(7gPIlbEkJtbcOB9< z0;=Lp)U1koP^Tj91ysfTs8hul-UP}I0Yl=K%I}nq6h*yGy-EFx`jqyWHqJ54vEAVq zq@Az)D7c*Gd=7hIhee@F!dZtikm0m8oHq=o-8};B7VOir`Ob2FXwi7TOxdWzhdp^V zU&47c%PWD;j>2~|zNPq<;aiUH7<*S=Kb1JW*H`Or%m%CW*AJnd!-5!J?Mdjs-2vlc$JH(d4=no%5!WYl#_) z%J{s+1|~CS|fclszgh7w~*FZ6zPj>igt^E{%+{Ml2l!_IogLr3w*66;IIXfe<1 z=|)c-E#)ZA<9=7c4TmqM|)PGu@K-s?C_Z zJNk*#ir|e%Ph+hQD22R?p39C-GD06KcG+b!!j)Yhle9dFNBN`Mq8U-kE}2Q<$pD_3 zj%_KfbU3r+TLY0IoS^Q(tQZxi#`;_0h$P!2+Dh}7i8&}5>E-+-{n0*7AO=K}oRY?{ z>Jiuu%DU5IvC z`_DC(QWDSRzJ@+pO#I0SwRHC{6crK_@aMe~S|7hlbr` z50T*6g_E+4bNes^XraKgE*Y+2F-CV;S8|5b{J^$OW46X=O6%rm*OoMzuqPIgjKm=+ zvm#DsEG@)FQWAqAVd6^F(hS2ja)KySCPhsnsfKYLCe&oCkK>Zn_bJZ#QUzv1TF&aJ zT&@9QgR}eNW3gY`}hsn$(ZpkK60gj4WD&r5RWE z_E_txG_5VVVPMlH8ct~%1X=?sO>4m_uy;ex&dyjelNIaoXnZ3gC7ChJjha$ODj_Pn0<6bVh9jNR zGkKaW4azkwkM=}%a4M0`x7D@c>d_gkX8+E3Y}4jsI;(YI2Z`+=$4OIRr{$PM(*#>I z@kaV~rZcRF#`I)tL#!v3%*d6qYE;l#f&CHjXMjfy`LIODO@T=Sfk-B{F=Ki%pq|s2;`=Ws-H$9xOf%iY0q{>HL0Q1m3Miy2^ zypqDyY%i*!B9>0J_jN~iEZIogFtZ!`3w!joFKLjo6wwfA*I_?GaeyO#2A^fr2FvFt zClx8u8+XxZ(m;VD@@m%!^`G&%@O^2I0UW=JgEV zx2_gNlAAfuFQo(mAIAws<|8&E_}b~tXm3BK7e#i!1^H|MOW9SiZWJU)WrLcrbP*-zhEgLW^p*>hrG2WiYq|A$KiP9KKVx2)8 z_7WnVB&ZJ~a@X98DXPI*sy7TDB=$i7 zmn56fB5~MGjoo4-dWt_|)0Sq=BwAa4L=8A0!H%sxa_-`F8?2jN#L?UaqhdLS5rZAN zm4?F-iTwuG)CovKhSeG<4$B-c^!Cz{v@5k$6j)+MyD1u^Nz?=?G;CMNtr&^kiG{dm zm+E%LBYg=9?P3ERIV>LN{{v41=s8CV~>Dk z?X3y#S8WSs6G_pzJFxjC?+}(BkcMd@>_!Ayr;wAI1IctA70=lAavhmC za(a_$owM2b%cC2uqa{{gshPlz7BVT8q>zqi1lxxtynW}GW(_%uk}>9No+XRs?&ylj z0_{sO(&=-tG?BZ&OwKb0`nuE9^rG>otd{sD>>c`&w1rC-u+H4D8Ig8L=PVnDp<``* z?9yopb!En4f*YTSqYv!U3n7CSbsScP30R620G%d=CeFKP-NJ*E6V?im)0VeznrutK z!Dg2I$0)60F&X#7u--;DFb%B3Nv#8kBx2?;MyeydJ5E(KjKm{Ao=({{&~_sk$N7zk zgCw*dV`A zV3LR+gb;4AZ7MDR2 zHzEwC*T-zlqp8-m6cch+v}f)%j6i9IIQob;LDn%Obi{EK9a$npffrNzf@lwXNzfFR z*4);{8dba?iwndoE5)}(==KT|?KlPurv-EhuyZc%o$Q1=ax>6h(M@rRA~-NNgcf23}tz~gA9whlfBqkA6P z$P+~ajVD09P;IGIFb4v8w8$+QF(b85&g4d286(?Tk6FLC*030FZoq-fR6*-5|<<1tXb2__9&>fi6u~ULfZU?LwGJ#SEOmN_q zDXK1g{%VC1`#6>g@VP7xKh!a=C$foKE}gU^n#4g1D7FWsM+at_guq4^8f_hj^dvAA zF#MR4EorT3Qs#m)+4p(u(`Px0h>n4N(ij6PVUw0@I1|$-?f>}TYstoqkSk1iS&HMV z=*A=uNqO+eDAha+mD{`pQ96VWi(-9QIQfGN&K3g+$Re2i>)PqCqAQjZ9k?cGg@;8Z zwjB%2?R0C&Is>z!58V!tvj)!4tfV#FOJxy&B?B*sS{YrzcOhlEE5!g)*h_YKi^2BG zVbrDa_!$lf<=}1Xn@|utiw;bvNlYl1Z79?1+lB*0;ACr7hrCa2Rakfix)C``;&MdL z4Qpnn1sI(tVisopOq^{=?w!fNo@*0$^hNq?lnV261=-65Nus;Pi*eiE4u<6La`bQt z8*kgY8RvS^Lqi^39Q6=D)|o~IHz@{d55FU0+xsXw@nd;O4o+&3(`2BLbWWGWv5og` zD`U~^*uU*S!07A7l@D#O7QoSsNNhH@W4DH_+$MyLjj7kL={0 zz(C`A>B{Q!{UE8aOm6O#SNky3=1ebmZ5i2=XlnIK`PMYpfqPZx+no(^F^K!j{hN0R z982&#A(jn9<2yw!R(&*G??jt;3ZlazdvXCM`{r<*jyHzW=F%B>#(f!yV<_@O0X66d zMviknp5-&Z)J-d1^#FrZnI!w5w|TM77D^%Hf+ST_~{=)Fd#f)0RaklHCj1@s_=gM;Zaz zqL3BvjNJTrR_)n*o4}U@=Ky4PqqVmD1SnnjhZ9@;+X#$oxKk*nWY!|>6T-7>QPy%~ zU5_bi=09)CbnQy9v?`t*fu0DeXh}D;5arqQY-@|+6=>-u*et@_sZzccydSU-PuF$e zNxkKOLPO7J%|f)d!~WaAPd-GpAI=$qMCyZn)EJHaFQ2SAw)OnRuuTMpTC;JHii zwuG3xihH;lCAY)IR7(P-sUGqYEVDLT0zD!tkcG8f{qes zL-{zkY4A{RgOth^w2J~}AKF4CdQihWzS7W&<99&ikfoaX(As|dvo*}(D<-TDl82Rt zEihk#PTDph$Yzzw%AJBobF*?sWtPp#De7c-{n`BZ$s}rtJ;1U`49i=|Z5)73@U7Zx z-`Wj5X(CDc)p~0{uNPu`CwgrI57_h=+6ZZBAF&31j`Uv|+G1GfS_~OnGw2cY#}>d% z;7bLkQHwz7gUpSbpG1m!4*k(0#~uY>YAa0_1F)}*1{-+1Qc3E28nrZq$zWxNb}@MA z5-`xfkuw~1EeTH#a2nirPZC_|CQ^koL3v8X-6|jHn~p> zPi@n{iF31TxqbL2O;87VKX-`?78E{+FWpg6KdOO3AGJ0KxDydq8N6Rs zPd59iN=U)7N>oW3;^VJ*!-Fnhj)sQ-amLq8gWZk-K z-N?I#bNmnK_!X^4HcUc8f+JWlW@~zEzW*V85y`g+CBF%dI~CuF_~LhjK;0}9Ks@LV zm|$o!j4<3Pl!&e4|66O?^Wn&W0R5e^0(ppB)|ech{#oDphc#7XFY!W%*ID)${7DB? zpp`xaUy5b4UZ!D11Bv35TrJB;m0sX1Le!vjw+S9vy;EnmqYOEpjF@r)4B>4IT2Ins zXa`|?`jqZL!#H~~3L&`T&2dPkeLxrTr7T)wN`uMW!E{WynRQAjl6M6(p&dntW27>d zc1+Z*GA3^4Jj$gV46QNKEu;3*(5D3(O$zp21l{(PYJ+=4{&8(&PdSlMobKar6KA`V z-n2YOTPMlWlk5r744Moc{wfV8)6GCd>A1EoE3VB#K8=B+xze6bCFIsja#Q4=!4mCJ zezeRPkQ%`YK*X8t;Un{I1+OxA@3E{#(>?hV`4KIS(tSn0h?@2}>Q!kssW4g4-v8M) z%nbha#vs!`*&$0#ax@R74MH4JKJ^2BFOpV2a+b4Kv=vA_xx13+bdTuWMOIu^~G>& zr5htd-v*8b-SAnt0+PK&E@bz|m-is8IbP0e!d4WO796<=a-A_;4e1urk~BZkx5sKBc@nQ>-VNjH~h#18!59=|-!NYj0=l zs451ZPxp#k4faD24NzLEQzaDEzpSUIsmC4*o7n4V^_5-?$cc!Qu~!$ixu|K`< z$Y64BMXM*d`nPc!DVKIyQFgckWZFJ`!t&+)KyKB>{VJELbp9sS?9|89->c|6{hRJ1jCNp%exhSRvgZyZZG+dDHA`!Y}c$BL27X}HQjE4?~Pu{B@bu*`8u ztLyCeKRjS$N*43K+A8?VB=TywR-Sm!NsDxDx%V5%C&c({UO6~MknG)b_8~isW?E9%lbMuB_LiqaN}fC; zlAbJzMjSUMjI8@Vl#M^SLB5r}qt4b(ZV>E~V5uGT>+ndH;Q^-|%Zuz${ACd=yY{2T z@v>IfD~VUuTd|vM#_RTT0O@u7dR*z>JftS!?646z^~j-9;1>p0GEVH^SW2r28rgEQYM*u< zEhE$a#Y|d&$>lVyM&&xl9sy)6ipCW0>?ll@lS?(|dqTQ&+PYLD9rI=0sgUy+S+tur zjam)LwnCCz2&SVG*_%c&=|VT8Ho#x9Bc5W}D1GDY=oZ>BDbvmk(3&>TVo59X!?WFx zPFs7sWt6uIHK)BJyWY(BCaomnfYLsEjHN9#a-2EljkfXYpaY)3g-+5k@{E5I#!cE% z6wO3F*)wClFUp*a?Fb|Sa`vYvpE|p4+6?KmU!INy-UJ>I6i>+(Nl28d28yq8_M3pd zs>Vq;jT~B|5?!ujSda3N>P^*^KM%ZHP;v$Ihvo5$nRHi&?)xlqimHsu3knk@uLYm?~z04nhK(FRv!3KT}!*B@H;tZ)u8Gii_ za)%~+T{(u~>otsAgFg5f3SX~V=n7+o6HLBdD&=(w;UAi22+ivsYVnpiT#A1^fo=ku z3G@)a-(^+&Nz|oKDX`%WVc>^dyk4)Wdr`C3(4dsZjlUzxa>|HJ1;1M2$|-l!KX19y ze^$BEx5qy?5p=G|I6~3W0P!G%=m*yWl&p&u!xs#L}JP$S~ zce-3ElI6~Et^&w|B(Ur-%AJOP@M1c@|6oTQvVz@&nd@(7LOQsyW3Yc$b zE3!#~;R>l9k8kkFe3#AwSxty@xisMAPB(h%T1rBYrr@_|lz{32Z9jxVxqu+#Mj%vc zfSw{KQ^Dw%f6O2958jVD(M>2n zIOtUkQuQGfa^%&ku{(2k4sc=fPSd4K6y#B5JMz8AI zL(&Hy_4v!E9(2J_xszP_C-5uO79jWc8mbN{@Up8wgB$1tiYOl=G>=l|w%o3~%y7X0 z2Zwxn$mOLkpf?O^axPj?j(-LWfNZTCRr!YYLoqlr`(PQ22L_kRVHn^;L6r(ZUzF2e zVAWe-c+jaR3n}ccUNSFCrJ|QqsHu3oF5T<#x0RzoXvw3VkV;9a$|&*;eyaEe|6b$D z^AEm^2L2ko1T!J^ChYYN{u@Mq!@dXJ4x_q3=>rDc?dc znX<@$Fl^C0whR}#Wsz^_PIBO(AE3bh-S4 z&*48*{4+WIYycQZLAhrP>Tt^RhaCQ)!;tJBdb!-csN6U7Yt&|CqUXxW%P?qI!gF5V z;9)1VgvH=u

1IbDPEpr-vG5&_I38H~2B6fd6CP(3_)OZfHBA;Q}rls!HXC5c)8* z(H=AwN)G-VUI~)d9kK%$wDt|X0~(r0DIO|iWg3m!AMRSaa@3?ZE;O1RnY!}MDT^l$ z9>6a;3CEzoj~L+xxKse(%R5?{1i}w~%vRk0-5&VkK3)Ej`lIMW zq4M=>W?lWn711$Y|MsIN6&C&B{*&(THQkl-;>0KaxV~~z{WT@;H{E*IPx219CX9V` z&yUP!^8dc(l9zrn`R#?%_RVc|z5CXQ=Z-6!dDk-^U%l77=IKx7FMa2lwcWofxnb^+ z|J+hj>z{w;|l_UcU@SJ5FEJvj2e=_wBf;+JrcRUK}C!jX15-t5~qOKDa0Ke-z~?U?p4 zS0ZSZ;*ZR0x-VDNRs7Uwp{nB#kNZLKZ^d^hz6)Je*mUS{d=T33Z6xG5RWGCKxdw4i z#KuhH%f*0He7Q*a3n}R@q$HLANb>CNZ=}ForXu($2-OIXia&-~1c-mD7eB*>`QJZ4 zxn=&HK>dhc`1{tFV7&r^$cy=x{`v7YL3u)HtRymxbZ8;xKqP45^A8|FlOAcXl{FxU zDUX7`jI~(p(5#2q&A-+nv6kiDJmFN!y#>}k3}dj-yn!ffHCJA|2>iro6hL_gqCSVeb%jFq6an@^;pABMUYhD}Ba^JA4uS>9 z4hy|y6v7R%QW>w^3=q&uoupHzf!T-6t%U{tqAYqG2^9%{Arc-+7!CuAI$#E2TM0Be z4XVXqVAjYgxi<+h zRS^>(yDik**xVFKv4rqb19(E2U)E>{we<9a_!aU*2+z~w9f@c+He6XUGYbeYM-ek+ z74;q4y6WdH>S)=7N3lcQ^a`xm9}0JOcW;=|IJJ4>_;j7wY85G>;HWoS1=cA!QyQ9^ z8c%4L+}waW-W`fqoIz+v3AUP;RewXO{+3;H24X$ktD5TzkSZ zcT9~9?HbpA{j-PX|Mv|uy0p{(BXW~@{70Yv%RAAlc0aSC{!jNEDqOgC{*C|j>5jFf zufKWii&q?8zWv%K#y1yEs3o8I!KE**rz;KUGPqH}6Zqati=MWQ@BVQ6#iyKD-+p&w z?QcH3_q+?p%T`ZcyCJ!@sky0XV$;O6^!~`&M7(P)z2Tc!JA7oUH8-5OHqzTYWztbu z4gK94sNVnk`9IMDDt_mdRweku>$on(6_<>U3_SSrT7wxxBxM{LMr1nWY(57645tv6 zy&=RMGOU4<(vtvJ;)rM+pnL+l9mgq)f!oj96W>o9AAL^so`}DFDR8`Me@?OzBvNW+ z=Lj6h5{+&`#c^~ikI-nLOvhmKIZjZiPUO<@Ucx#&lea;bLEP=g1&d-GV9`<0rV%8) zi+D}H^J@Q_ghM_|4)_&S`mI)Zm`1m5ts7Ta&+^nm_BI?-)uZk7h(ik>77{1j1(gpg z^gv%a3Jrro|27CZf}Vw&W@<6w-EP!76~FOIf0a-6Q1(Mr zr1umYur}jnTO*Ft8*m)o3`q7pnSbwB)<8GK=^(EseK441fsyKNfYv+krO!ozeusA< zF#PQeNTGJq;WxEt6FfQzp4(v6X4Fi&jAZp=S*rouEs)uRYg!&{py&{kj*#ggZR;Qz z^(^OhEwOmX>qsNpK7{c@yZ==C=JD?&%g4*@Hy2XJnyB;Wz8~3#9>dtg-;srG^pJ;q z17diOjoe=iBY1DNmmYg8P}$*Qp#_KAbD#lvO*fu$YsMI&TO)Mi#`c#fz$Sv;ge%>+ z!SV{9saXCh=n=ZDKsOKR#sb|o9Nvz}>}TX_(%%-oBgFd(i(v54!;j23X-98Q2rt#q zk7&%SYHDb#3gP`J{t2F$RrvMQ`l(eR`o+9%yvo%VomsUrny5NyR-Px%Gb3XCj#LOD z`Vup%2I76w6J495y^%zHuf1BX?=pL*M-sga+nTCEc)u#P5%2QZt8cCk!a|{xF!_>t za%YxK4UME%AKpKnS+!_q#)_^1uc}o|kP`3<2ZlT?emBg*L5bt% zGNES_?^eaO;XOk9z~)z!I?>lF3@R;uR|IMk(s-eBAipF!Q&(YmA=Px+_ zlRU+x9yq5u0g|aIN>hGgp6*_M{sJYcIaI|d8rSNcT3vA{=bWG_jsuGu7d94WQ1Tny znj#K3Zc+zDW7Dv*j?fL8uDj>!gLP+~y7|8T&p&=)xw5$-DrSHD{tJm+XTSFQ0^`6r zc|(ooIKOB-NBjK&O;uDifLBG7f7|k>hAVD4`Mwv(*vh|=SW8(Y2P&Q2l+)3N-o%F#?`d_%R;5LYXxCnhF}dM05pQ_(|Sgyr|zarm>7Do^^{^j_4KR@Tb&qlYN`{vI-EuH%ANx!)4_&ct- zsmXKs?hPLdJo4Oviw~SW@b{~38Tg|5rQCPkeWR;?*5vnJx_ZNZZCmll%9p->bJufk zz4c1|^}DXG+5YFpUQT}d()lmGexRwo>^o!Yo_J#R#*SZI@$6f7FMt21o(Jz5$XQwP zv-Xa=l8^ky&CmU1>U)=b_uyaDf7xX|f7TNd?)}BU{Qlcd`uzsq`LEAiFrnyg_qi6D zvwnWUAFrNzQO8T($=}y+ownwqzdbqnlc7JIKV{>?oe%%p@mGBqTyw(cO5eNgZ@f}+ z&y&CTa9-!~+2?4#yG4bgDhJO|&W1&HHCCXn%f~uO8iOfsUTEM?O~BWkPM4-NmJ@^5 z5p)zz{p&9#JXU_$;XB=b8Q1wYv--Ph{_oS{yjfKSO4CFOWY=j%tPMU)2G^tTFX*5{4ps)L#rOp@6xxM&= z|EIg_jA~-*+G%u0i_7in;4o%ZwW;}l%jNyL@6Rl5fu$x1iKVP zK$I>;K~RcH(Ql%F+k-n;I*UVdcd40F!Rob0`y{XBDKkAlDr?4^e%VCjH4`H*}F zW55v5C+HD$;~`{|6j4t{DnN90bgO0~>7s7N_%<2LLbY_+K2tAD}0nI4czT4FLnQDQc7Znd^r?IwDW4bzOb;z%nNNxnJi z!HDs$PJ9CZyZg-bYBB{u<)x)o#diOyGD3!4>P_1yZQYexZ6m8dcVdu44vV|fmDKbp zqc3;dAIhtQK+tBC#di^!j|H-GYWNu@bf}uo$BYDy$B z3yw}omb&19Xo0X#4pTQ@vTbA3){YM$wP*C=C>F-niYIfJlgFQa47EpOXn=VjG# zYrGE_WCUNFI#T$-N=KFL@{M;as`2&@epJ;Io z&cW9M(PXK3EpOKT+2_1da-YIU-N(*)uyPXb#gQV~XjD=&%L8xk{kmgPW%y|gjHjzC zf#1J@>YOQK-{@?Azeu?Lz3WFw4{%!2{tIPGs@tSS?^sjJ=@h2;V-4QCVb^_@OZ)8{ zFyxitD8bS-jWpY)vLvYaG}?{@Lw4VfQ$b}LMsLU$Sw(I75^Ff$@M6aTA+P{rGUU{ z6)s4P6JQZE@>B4eAOJ#v0w^Q`a!P;_83g3NH$g=UZ2s#Yg@^qX4q#+BfPruT`dr!E zvL6$V^wnOk%XlVZS<=Uwmiz^p+!CHs)+U#4Q7UpF^huE|^gCZGc($?h(#El zuhb1?Lu)=uUuqYixV(O2bc-xz9hs&MVsxw=d|Dh7_Hzcsa`j6%(8orJkvu{X9BA z#n5dNT%<2P!O%cp4Qx24GP^Rm%bJPL_>kCz5WgW7q6SmfC>28xM&n8CJ)B}*o&E9`F`j@3@M zOJmgfyhsb>pZ>|~a}d%}lGWBeJx6uFOw7y5_#Ff1_bp^p*69+CWpxd`h)<&1fWsLO z4yOPnN}Ba7j~$8t6EVmZ{QF%n;@s@O21C&Aqy^Or^71BdNgO~&4)=@*@-T4#<7Vuq z0N@}5`~v3uq?BRk6s_BA6#ItXmfS;k3MR+`*5n?12oQ;Y{RCrzVVwRt3V~?#TbTQf zaXvrFEPqEL&~HJn1)X&h?Cby;I}GMK*d5sbHxTSh0TW=~MjHe>%|8P>l+y;%{mJLAJ({OXJ1W;aM^&k$#dF71xQm|O;0-*dG&1GrM?p%jfaoNLLR0d* z?yiB=-5vFEvtGjGZz@D*I$qCjtH>71%rf4lLidq6;RRm{hGS%|RqE;C^Vjv2XxnJ- zv|TNKbFHtRJ^p}>r6R^xlq<4oLG<&0q%zVY>zY-9yO(!Kjem;|+Tnn$0d}iF>%lXeAw-a+jho2N>cD%QB(ilBV zm3LB=GLW*9vg!mMTZ4ncjk#BC+=zxjjeFa~-VeB-rZbm_HW|H;7ew89tNF|#8pFLz z*-?BQ5b@Tk+#)rdz@2h!T^BACgoFqz?@i|`ThSAYT0H-`(X+-dbL8ELAg<}R3faLN zhTmRP3%Z{euUK9^^^Pv;t;g<)RbU2TbY^hy1lB24r8ED~zWt3+76QZ|W(sAQL0&E(fKEC zBDEYNMIgQVA%y$+AH=8v>jLUs-CCc#*Ht?f;lP6GWAP&JAt1|fs6Yia0c~k>-2j;V z3+kLMe$Tr}!f0pC+foN!yE=ZV>8=*+dP?F(vpkReR(t6a?Io1mHDk+|?Mh!Cpq(=x z*V7q}K5TnHH%r8`d|XyMS`5hs*Yw32Ju*#}jt3)u^mAxTJ4&32dl2H9Fk zUw2gxy0)&SBwTCEuVX-=#$>$tuXmOUug2TLXwF7<7Sv>n+4}1Guh#BrTN! zc7bpLl1ibUX{o*+SVh{)c`Laz@&GH6xj3Um0HGhd^P0OmfJOX}=4NI{9kYGPirTVh zDOpWj1u0D#O$D?tAV}U1&dT$1SaMY^DX?A`)(5#>P>_J%W(?pFUqESQc#AZneEKx{ zQ=q>7o$u0&@>atpOEY2r$V9AP8Jv~(ch7iTm;u&>82~MZR=_A?Fyx$^oCRRkoBxx) z6KLzdP4u_wK2Pn0ChQn9)o6@jdkg04l}aUikLHWES%@$RRrmTy@~J|)Yh8o5Ukr@2 zTp!21726FL^U~`w{CPI7Xu*KH6Faq<0>B*F)2Od#{vI z%>-gb%m4$vR4X4v`Z)KE!?ilwk;<46~_`{JrcH^fS=QK!YXAFyJ}{P=-N&&rGd1 zGCMFcC5x;E8*MN%RsADaA?rLpGt)m9``7vlEBOk95%d7<#v$O;zj9+xID|ruD2%BV zLZvPS!NL$&gMD7=?R%%Ny;G&T9!n1lDp|jTXuJuaksV^m+vk4#^!1)=dyv#EFvH27 zVP%O^dZJJ6USf2dicL|OlN;bGJ-|mwIT3I#npdr!blpkVIpg_R%$id>X7`)(wsEi{t(9HYz~dr zo+RvmPFVa+m)p^+FZW%Umiy6^B{%=&@cdVis+52c1}-<+wth!%p6U6~1UH|M5^>9xbh3qkw_PQS} z_2MuwJN+HpQtfc&Rqbbu(wgrU+jcszdWp4heTj>z9duaLZ5HJfa%1u1;!mtFbWSjF ztg>AT(P0qurOCLidXwh>o_fe+a zjHi~H4C1Mr%6_tE0;NqVS$O4KUkGhR(wq%?vRc>lK->1n_B<%XegWf+NHq>ds*yjX zKeJPY<7IJ`Eq23T$a!wL;qP# zru!9*k!_J56~e96cs^za8>E^-Dij%aETV#OE`6mpJjd=mU3wS-@iqjsg#`Ar&%lc^ zlC8w+ZmuDQeF`uJqH6~$P+xDpIU`f+XqVG(p+5EDX|`)h(zm0Ik*`|~=u$;Sl%_ci ze4X+``LQi|7ccBtjttK@ni5ou?HbPe!n>;2dv2kvh&Cgxu>L$(IYKk~){UrK0Y&5u z;Wy6HpB5S;oUDWyL!^}~0xtMorc7i^*iLdNVSbd;yG<`As^xW`nUz$N% z|11G&hnJNmJH6{a3_}Jd&{TzIl|Q-Y1xwZso7jDHucSfynCrFqpT|4~pKEuK6kdw!EQ;%m!y*)i7Bh4bd*n~0{<^Od5%D$Ik zx2j6}Gp?0rUU<;XsbM@6_eCP-BC{*-tkxf6IOr6*n4O5?zQ1_MS`=-yULD z>%mcv0gL9&0ibE^@wo8{L!<5fsr;Rsim1AFOA6^(27-y)%UK#xp6==hxt-Lcm-7A3 z?2-rkD+~Ot##CdsX46 zDo6EjOzu220Tj(}QH2rzGH`9VWd%Nb2BUzCg;#_D0vwDR#1N#17&(mf<_6jI4L~3m zWqybcAPYr6(I_zIqg@|>tg_OAA21ll3=C98slI<_?)kApBxIGmgZ!56F!DX>O*Ml| zYheUhfSTM5PDMl#H@-vT2wQU$@RZ>=9OUH9*SEvQ5A1%$h9Y%-2tPi3&+kmK`jtiV zA)i!fkHwU<`?j)ut2Repncr8~S8Wz ziN?bjKr%`5U1mD_@BX4cM5f>2vRg$aJk$W-+LR(dm5JdOV#9BQq>;+oQ#n_UVNO!{ zytO_vyOwNX|6=XnH}2DcO-&k;48{O%dCLGWaCPrn05<{P#sFMBxKyH|BZjI}(r$&K z9~Ci6sibxxrqO2jzSvmLqK8)4bu56(`Y&*W-=8>8Mbm7SlbbbIDU6Cv?eaC{&Og&a ze5z6Vq;ooWm626uQh%#Kf1_H+ z-W8*UP(GEV+;0$qbBA~Pmu>u~JLvqdrHqn~ica+$pZGj7<$aY8+iOe=s;vpw?=dx( zb>8Miw<)`kWQj(i;n1r?dE$IrA4eiWG@^F - install.ps1 - 2117 - automate.intunewin - install.ps1 - - TL5w2kSbhW0+Vb/ngucj1fIa7YfAnFG/d+U3o/qGG24= - NGPnJKKQIPM4yD4dCJ0GVCF0pqFsLX2TCb040bjLBBg= - QGvxYMYrgYovA6uo9XQ60w== - Q8PF4sGPbuxDyoQpmJUGVLvZw9hGhOBX0IhQNeeQEHk= - ProfileVersion1 - 49a2kb03OrNyDt0eZHSpSARq9HzvQL0IrBkcPffwC4M= - SHA256 - - \ No newline at end of file diff --git a/AddMSPApp/automate.detection.ps1 b/AddMSPApp/automate.detection.ps1 deleted file mode 100644 index be2de760777f..000000000000 --- a/AddMSPApp/automate.detection.ps1 +++ /dev/null @@ -1,29 +0,0 @@ -$ServerAddress = '##SERVER##' -if (Get-Module -ListAvailable -Name ConnectWiseAutomateAgent) { - Import-Module ConnectWiseAutomateAgent -} -else { - Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force - Install-Module -Name PowerShellGet -Force -AllowClobber - Update-Module -Name PowerShellGet - Set-PSRepository -Name 'PSGallery' -InstallationPolicy Trusted - Install-Module ConnectWiseAutomateAgent -MinimumVersion 0.1.2.0 -Confirm:$false -Force -} - -Invoke-CWAACommand -Command 'Send Status' -Start-Sleep -Seconds 20 - -$AgentInfo = Get-CWAAInfo -$ServerPassword = ConvertFrom-CWAASecurity $AgentInfo.ServerPassword -$LastContact = try { Get-Date $AgentInfo.LastSuccessStatus } catch { $null } - - -if ($AgentInfo.ID -gt 0 -and $LastContact -gt (Get-Date).AddDays(-30) -and $AgentInfo.Server -contains $ServerAddress -and $ServerPassword -ne 'Enter the server password here.') { - Write-Output 'SUCCESS: Agent is healthy' - exit 0 -} -else { - Write-Output 'ERROR: Agent is not healthy' - Write-Output ($AgentInfo | Select-Object ID, LocationID, LastSuccessStatus, Server | ConvertTo-Json) - exit 1 -} \ No newline at end of file diff --git a/AddMSPApp/automate.intunewin b/AddMSPApp/automate.intunewin deleted file mode 100644 index 62ef0e2259630d2d7a509b188f6b660ed9e103fb..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2176 zcmV-`2!HoO!^Pskk8bQk%7iJHl?GJ1*~8dIgy2`uh)^}>kPvx5Yw=*lD}jnH1FNX@ zbUM?Fcyz>$=Ebc0euX$J&))Ap2^5~>IeOR|!Mhp<+fjvHKz?nb_=cuQ}) zAi=`zX+-IM4Q%7+GACg-K}yPyD}QsOwp66I#Fx@8xtAg2+AYgAJ} z^zef1^ZJUnQ6TSrfVV?^8)O*|8_p6m=jLy~MN1lRkd`N5IfTLgIY%Ij*7(SxdgcHB zhctPCl)`>W#h}C2IMeDz5*?^D_XSb7Dthag92OWE?(bptxAxZm4A^qh2p8IrygI;$ z7TX>+$s5}SNM7g`|3k-toqnsvc=5S==v~#3D_}_)2X%VFH<1%Q)+|6q4m0Wt_2?%i%iG(tW|vwr zP;J47Uk-U;?h|*m=S%7+bQ?N=1Qfc&(-;)PlxiLW^KBcg_i;NsM}R9Ir+}X@v@b;ded{mAINv zS3H422bLh_#F>dAcx1V2TQ*+U{h*uDQ#)Y%A}*ZHW3Ih=7$xuZ2+({p-+X*K{V{E- zRkuWj#(3(#v~}^r>#7wny$CWEU(0WAm7mTLBOH`alZNVU!+XRJV!hQ0p>Zgt|en_yw7TErmZ1{lQisCo__B;Mc zeJ)%1(+@RFu+H~xZ8-<0RC;4ov0J#bLo7+!tf z{pvNefOKS)G?mFQ4AF?^e3g{3aJTM0*(S{KOwBPxkBoW=-4;C}*Ro?yN`I^=xuhTq z*U^5!w#RGKd$ao_0|q=1G!I*=dPy%)qvxn_QB=;ToU3F{;fT10nj|!ut_0VN{kXAY zINZ7y6B+99N45%k+y|#vx)c2ih1;V4H|F-tfYLyEG`O7bT8r8wsTK|!HW0c*H{-U|YOI{ionR}fIsg&7dZ z_A@qDtZ2e#NkrX!X5NXCl+!Ps3)T-^7B9>`jUOj5-Ax7`%9eJp*126V?_v&8`dW*8 z4r=)IGup@WgoiP->wN&kpVt~6sA2oxA9w!tK9^4JO^&?nwVWJd zv=($KI;QaanJG^}MCp)&!uXIDPUGD>LK>_(LNzYoj=G{;_ItU9{|9;eVliB~q{mh2Hd?27e z!gNdkyla<9#An)=u1yX!bZU&Tp5&~lmx{TtKVnJru*#N1q)9qDOi$Fu+cgCRXK<)y z+j~+p-ni4E$+fu;Gl&)uDCnD77pbQLJ!;d>S)6vjGrD05!aLOFWx_*6B*%i#Ju0pu z4Wmx!%RrvIwIMg(+*P$~2Z>T;YW?qJaL>0-Wj+AlaIq9@^syx59CLr<1awP5VqOl| zV)rrA(=s$9*NUHfZuK!r%lqwi!e`bm-leVE)CY$!skxI6FOe#zREz~v9Cu=b4=*Rx CKQ(Fq diff --git a/AddMSPApp/cwcommand.app.json b/AddMSPApp/cwcommand.app.json deleted file mode 100644 index 2d032177b625..000000000000 --- a/AddMSPApp/cwcommand.app.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "displayName": "", - "installCommandLine": "", - "uninstallCommandLine": "", - "description": " ", - "developer": " ", - "owner": " ", - "informationUrl": " ", - "privacyInformationUrl": " ", - "fileName": "cwcommand.intunewin", - "@odata.type": "#microsoft.graph.win32LobApp", - "applicableArchitectures": "x86, x64", - - "installExperience": { - "runAsAccount": "system", - "deviceRestartBehavior": "suppress", - "@odata.type": "microsoft.graph.win32LobAppInstallExperience" - }, - "detectionRules": [ - { - "@odata.type": "#microsoft.graph.win32LobAppFileSystemDetection", - "path": "%ProgramFiles(x86)%\\ITSPlatform\\agentcore\\", - "fileOrFolderName": "platform-agent-core.exe", - "check32BitOn64System": false, - "detectionType": "exists" - } - ], - "returncode": [ - { - "returnCode": 0, - "type": "success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1707, - "type": "Success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1641, - "type": "hardReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1618, - "type": "retry", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 3010, - "type": "softReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - } - ], - "minimumNumberOfProcessors": "1", - "minimumFreeDiskSpaceInMB": "8", - "minimumCpuSpeedInMHz": "4", - "minimumSupportedOperatingSystem": { - "@odata.type": "microsoft.graph.windowsMinimumOperatingSystem", - "v10_1607": true - }, - "notes": "CIPP Uploaded application", - "minimumMemoryInMB": "1", - "setupFilePath": "install.ps1" -} diff --git a/AddMSPApp/cwcommand.app.xml b/AddMSPApp/cwcommand.app.xml deleted file mode 100644 index cc23edaad6fa..000000000000 --- a/AddMSPApp/cwcommand.app.xml +++ /dev/null @@ -1,16 +0,0 @@ - - install.ps1 - 2717 - cwcommand.intunewin - install.ps1 - - 6bilNd8M34xxoOl/marQi04r0PjYRD0YUuVf5hR/cVY= - QIeCE2WnKhg/yyyN2Vd7WBqy/9Vo22oOY+jN+o7NsM8= - fPjQqWF6INy3aAXKeGIlig== - qWx8/p2CoO2vuP/Dkr7KJw7JoxhmcA4XSj2ictbcC7M= - ProfileVersion1 - fslGge4BZ0F//6xgGCNIIVY5VPr/B2Ms1sGI7RiA9Bo= - SHA256 - - \ No newline at end of file diff --git a/AddMSPApp/cwcommand.intunewin b/AddMSPApp/cwcommand.intunewin deleted file mode 100644 index 3f93872597085254880ee5496d9491cb4dd37d95..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2768 zcmV;>3NQ7kY<&Kmf}riMxc|eFzRD*K$)gx%a1IwrJ)&~f+zYdO_|U0gdLZ1lXa&l6 zVkL?R2%e6f8$RNFRUm)WYfBG!B0tiJLyi?}09haF({-8cR^AMHtGN~%8DKPk& zTb+}$+r2T4R^z)jF*ncpcM7QOyzyA$W6!JzAG18V0xs0 zl!EWFkC_BVXSyIkE<)HsrsVYW3I?r^Twk9^HT74W905!UMR8(U;#8R>f7BO4Ak<=(JWTX9;O}+<5woSK?f= za+&yG5P+wP5iYQ$s+Ll)-h;%m^6GUdRZVFqDLD#^-(HYZH`}41)_AQ<_)w|2x1QTw zJRoWw_qw_5hTQY0!l?8?7C=7{YzEhg)*C;At!2ZnF_(>cK$r1^noN288AYpjJ!Rb*{nneVWXSyrXtkM-p>dt&nmRs zmbJcE70t1?H#7>wH8#Gm2jKU$WhB6c%LOCTO;>1#DGwMY6%xlW7)B`kTdcT`(} zIevRiNWB+2NQ&nap|23`lKKG}wL&!1-lB>7(`qj8N)+*5;J925Fov--C7}!;Ugy?k z!5OT9UZye0+530*rtssr`6xz|Q+q4c=I|dt% z&mzju`nuC=6J|i4ELz zOl!HS+G(4*?gQ@j$K~H@)H#(DO9UgsMrA_J-m49(YhGKXL@a-W!6j9(#+D;eoEEur z^I5;cRze1s3boqIjEW7w^3>|z+Supb*Delz)<=9>Qj)H6%C=(JVPyl7RgAYtx&@sn9c@^%`rlfS{uR2C9;4DYlyya@JPoxMp3y~J_OM^ zxPPqLfFF`b@QzBY%S?V7-e9;(!siI`$>DD1ED4yS(ijA^E>w`qi+~E)L+ap~`p5zJ ziUHVX5I?#wU+ljrKLX5;I>ty>6T=U32e}%iv1`D zp)3WqjLTm-|M)mq-IDV)VSVI&CdF@&o{D+q%fTuhfzZ^Y3ypMuA?X zmA2uXR4kjh65z8Lu3iS+V(~=*ist*1PWb_Xo9}rDTKh_c`n1?=$Mmw^6*86M%OK&1J>KI9*yb~TI11$jLUXps_D_AZZVdCyJ zcck6@DsfaMiESzdjHIeaEzPaSg9*Mtw<|gsY!K)r76Ora!mJ-+!{N`+U}iS)SVHAG zA_?Q+q*8MBCXscu!UsGk=QhfpfdSd?uu)1Ip^_)S7*gwDC>ogPgsh1r=pTc5O`cO+ z1Ezt^R+%JX_9gHA+OWfKEv83a8!mw&TL??j_LdYI#%A@78E0ZEhpm|UY$%Aq4yhBC zT|(5!npCx)5|k74_g&ysT7+e7AiQl18FZV` z9N6Luq-?znSdbT#3eNh2RyZ#ruywR3ymj^1pZjETuWJpT+AGIV91+of2MXP?Hh=K^ z#QROCVJ-2C*K4>}#1uS7)Tucv496zp_VR*aXdnmtY4WbCZ3Hc{UP~~fuYfa2z6wis z?%fGVn27wCi&@AES~R|;*I{{!8XTka9}={0-${Dz5Cy(>;gC1y;i`eQY}pRKOw}?w zLWPdFH|fAL8T}R?p#0-Fo=~~j(@6IizhkfJC>}7qz?-O(ko=&~`OcroSMpUyiTJNH$*DVSGZ{*B0U8~Q%ukho+yo8|%4(;o&Un?ROwHs+F? zS$Ls`vIycxO#VPMnzkL@6n@S^8ULstd{DUB$8~7ixw$p~H4Z&;YI8kY13j$MneU=T*2pQ!iM& zrhl}Y7hpFs54waD<3by8xqU2-U8hE{R>d3haESEkEHya6cjpp%hsEQx4t7MhYfNqG zIPqMzccQ?OEgq1!{=9!HF#J1Vg9=0eyY^5>(u||UHnbuqXe4^2t#(T1^KGiOll zo&L7U_?9f>wW~wIipGD}=&ZBeI>CZs2dgxMzGRq^_{-}9S4t4!b}{u{RBM)ny=7h$ zXe=#1^WknvIHijx>99LxTh)x}@DOwtGRe$yqboP9%4H0z;SO;!jr87s4Z4X~x9Z@5 WKbhY*0o9bA1j{3i*36HUE9HiG-dt}0 diff --git a/AddMSPApp/datto.app.json b/AddMSPApp/datto.app.json deleted file mode 100644 index cdd10dfd8aeb..000000000000 --- a/AddMSPApp/datto.app.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "displayName": "", - "installCommandLine": "", - "uninstallCommandLine": "", - "description": " ", - "developer": " ", - "owner": " ", - "informationUrl": " ", - "privacyInformationUrl": " ", - "fileName": "DattoRMM.intunewin", - "@odata.type": "#microsoft.graph.win32LobApp", - "applicableArchitectures": "x86, x64", - - "installExperience": { - "runAsAccount": "system", - "deviceRestartBehavior": "suppress", - "@odata.type": "microsoft.graph.win32LobAppInstallExperience" - }, - "detectionRules": [ - { - "@odata.type": "#microsoft.graph.win32LobAppFileSystemDetection", - "path": "%programfiles(x86)%\\CentraStage", - "fileOrFolderName": "CagService.exe.config", - "check32BitOn64System": false, - "detectionType": "exists" - } - ], - "returncode": [ - { - "returnCode": 0, - "type": "success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1707, - "type": "Success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1641, - "type": "hardReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1618, - "type": "retry", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 3010, - "type": "softReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - } - ], - "minimumNumberOfProcessors": "1", - "minimumFreeDiskSpaceInMB": "8", - "minimumCpuSpeedInMHz": "4", - "minimumSupportedOperatingSystem": { - "@odata.type": "microsoft.graph.windowsMinimumOperatingSystem", - "v10_1607": true - }, - "notes": "CIPP Uploaded application", - "minimumMemoryInMB": "1", - "setupFilePath": "install.ps1" -} diff --git a/AddMSPApp/datto.app.xml b/AddMSPApp/datto.app.xml deleted file mode 100644 index 145d910d8ef3..000000000000 --- a/AddMSPApp/datto.app.xml +++ /dev/null @@ -1,15 +0,0 @@ - - install.ps1 - 705 - datto.intunewin - install.ps1 - - sL/LP/JZ4F4cBSykm6usgJoV1PMoqd62C6JUwuo2z24= - PEpeqeoX7jAWxb0xHGfCkKFxh4/YRfoMTVXrP+uZWzM= - ulFPA+vYjaxX0pvq0BMAKQ== - 28ZFU4AT1OznwF8pfqO8i+WFUNSf9024H4Jw2H7UJWs= - ProfileVersion1 - YEb+QNQCko/uZyedA+JfcP/RDm+nZOIjFN04CfhwN4c= - SHA256 - - \ No newline at end of file diff --git a/AddMSPApp/datto.intunewin b/AddMSPApp/datto.intunewin deleted file mode 100644 index 607b0725032b7f93ba2226ea9af588c77620ed96..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 768 zcmV+b1ONQn#zj+r6V&YIz+WkTqr8jdg;3O=_f5DTf^gV=)Fo@WQBMQw*o~}L(wpkg z696gpMu|)NYJLjr%TdhbceLGQvAA|Rw?=D7s?71sb!hj>flu)7fRS&2F#ScOxJBP!Ach7YBiqM<;i#tw_eo-=kh}kQ~7HEBBUW*6TN~)a*d~XIKqN zI}Fw48A9=bkVcfnrD5f>r6YDW+R|__*Y9#{(GcwYmMoR;SdJseBPMSl+|dTDlP3fQ zGBAIuG20Ts_UV3QL_B*H2Dv8X{SJ(|J1`MS+M4n!30whDzUi_Yvq$)8%{tNr6LwEe zn&`BaO7@BVL1YqYYr#;Gvx5HWX!-R-v0fz1mj+7L9~)OvS7Y&K8gOY0`{WmfK0ReU z#cKd|L*JRtaIq}eMQtFKaUF?ks15>w)nQiT&9_^efEakNs6*|3XdB0VlJmD)B4($fYMQO?TX<88h~DG zeV5ZVvlz;S(ix&I7D(iq(-sg#z|oLS%SFR!nU8UW`1KK^DScagjah5hiYk3PZxIeW yot}Zx9?2Er1qjM_Nz>yn$v&pkqwTBb(stS~#sFe?T0*@_dBZ?}Vr3U(_4eNPW`&6W diff --git a/AddMSPApp/huntress.app.json b/AddMSPApp/huntress.app.json deleted file mode 100644 index 46c8a22057ae..000000000000 --- a/AddMSPApp/huntress.app.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "displayName": "", - "installCommandLine": "", - "uninstallCommandLine": "", - "description": " ", - "developer": " ", - "owner": " ", - "informationUrl": " ", - "privacyInformationUrl": " ", - "fileName": "huntress.intunewin", - "@odata.type": "#microsoft.graph.win32LobApp", - "applicableArchitectures": "x86, x64", - - "installExperience": { - "runAsAccount": "system", - "deviceRestartBehavior": "suppress", - "@odata.type": "microsoft.graph.win32LobAppInstallExperience" - }, - "detectionRules": [ - { - "@odata.type": "#microsoft.graph.win32LobAppFileSystemDetection", - "path": "%ProgramFiles%\\Huntress", - "fileOrFolderName": "HuntressAgent.exe", - "check32BitOn64System": false, - "detectionType": "exists" - } - ], - "returncode": [ - { - "returnCode": 0, - "type": "success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1707, - "type": "Success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1641, - "type": "hardReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1618, - "type": "retry", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 3010, - "type": "softReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - } - ], - "minimumNumberOfProcessors": "1", - "minimumFreeDiskSpaceInMB": "8", - "minimumCpuSpeedInMHz": "4", - "minimumSupportedOperatingSystem": { - "@odata.type": "microsoft.graph.windowsMinimumOperatingSystem", - "v10_1607": true - }, - "notes": "CIPP Uploaded application", - "minimumMemoryInMB": "1", - "setupFilePath": "install.ps1" -} diff --git a/AddMSPApp/huntress.app.xml b/AddMSPApp/huntress.app.xml deleted file mode 100644 index ad4f731a67ff..000000000000 --- a/AddMSPApp/huntress.app.xml +++ /dev/null @@ -1,15 +0,0 @@ - - install.ps1 - 8859 - huntress.intunewin - install.ps1 - - 0wrFiLHex//63XQZEbX535qvhQE5+MiZmfPho1CMrT4= - UOlXFsrh+Pq6ZZNmg2+gzuTCSDAxQNUDVkc6oR5SVAY= - x0cPnMjK6AZARRPhOfC5pg== - z+N/v0mfq8T871kS07/QZ1Lgay2hRabSxwDWRKz3fG4= - ProfileVersion1 - z8JuA/5iCrLM1cRkhL3di5eDysNsab62E812KGsrkbY= - SHA256 - - \ No newline at end of file diff --git a/AddMSPApp/huntress.intunewin b/AddMSPApp/huntress.intunewin deleted file mode 100644 index 12c077f56145007ead1c3def1496abd5fd0fdcae..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8912 zcmV;>A}`&~0M-QCH%IF3_MHAsU z@VTad=y|Mx^AHqo;QG5|2P}i1KdzV2Ek}`b0-xRQtaSw?Bi?|w z?XL*DJC>q%A=LUl4>{aa&hy+d#QkN^|KVw3#1pI}6@(q}FSxD3vHJ{jZ(w{npG_VP9$TtC+Sm{Q76kT}WvMRMQfEOu~Xa`(c%V?X?i2*AI@wbdK(({^*E zf@|%{GrpectSAyFoOQwxi>G+IN~o)h`OMp2pM4hYtepw3c>XY{OoE|&wm;$wb~#J3 z)~OG!M@0Aojay4hQ>Cca71Z}ZwSEUAo8U3#y3KE?ksOZ1bQ9xI1#d5FtL-`sJ@VRR zMdeib*Gg2F=il~~BoF$+f2AZtkj4j7J_v6v`Oc7HjXZ>`N)y^pkD#u^5X>}i1tl>~ zCIS=TD(IJF+Wp=|M_Ww=@pH#eZ+zy({XwSZZGi8Nw;G+i7&po(KN4=iT|3l%_6kEw z%QSpX$gkcT_N>&^pvH!sXCd1ho$nY-q(7ZzTa3=WK7a%${8|eHEL$qfn4L;rl|BGj z;N@|!CwGn*Yx?w_BUASu4yoVIm+T@|{+L~5RAEF)_O9Yv2x`&P2V`JFjv1pJDjkji zZT(!n1c(Vx2RJ+GKTT1tUQ7dUUf8v2IL-s&yA=M6zs1pvv3C0ECx6mJ2K?J_>OiXX|=oi_eyK%B_j@}JsI$=sDcrXy>}g%*6D z6eNEA*@(B;NB=C%Ch&h<+2Lo&Yr$~`#&MFQ=kmCjdo!2Wi0x|oq;Egl;4db*ZFBYu zQXG{{koa9jk25g28ICSQO#kz>HCRYWi0ziZ-!pAD_BTT0t-*{%o|Srn&ADs;^bBt4 z71&}$M>(R%fYM>V%UdoQlU*ncF+%Dw-3pFe7YpFqiZp<5Vf3s~u*7&LQDI2W^jcam zppKSsG_^qHCo;571iqX}^ar0xQG0{516LFXEw=%MiV?_*R=TI*OWeq5A~g^dmOS%b zc^p@<4>zAnhxM4K+gc53$6!=wEpHqAUXMV?^Q#-!hf&DylJ;iWDEsE`k$k$3rZWSM$-f%#8zBRi`LA_Gj3N%O5#z5F5e?sw10j~Ji>{wWSExZT5* z1GGonUQ=Hp&M?`a;j_GLh5o1Kl zDodF*JQ=rI`H*CbfxtiuuIP#aIqaRi&pm$6#KiE?kyHN~QR4N)Q#hSMxhMBgM#%nX zbIgpRa$9FO*jy2j`RMXb0ps32!YX)ZLIAh#MrIUpW40Ekk7tLi=_e%Ga{UE;0}e*W zZOL>AolD`*NxKwS;UjpS#C)ll^>e{c*grC@mEyJvp{Luwf5zDs9)|0Ul_^B|N$8+% zd-FTi_~(&4Kw6d)#Mn(a;*NC(5g#v`)qxgMXDiYUt0mrW2yoJ8+Hx(~Py=_P7uCSy zX~M6Zw3za@yC;JvELi}f!iqCWE{43=BEbi=7x75mFB%f#ua=UlX{IJ4&+dxb@xjR{X zMfE7aUXCDU#=VgKY|6M%kek1>I9pH_h|2TNW4Fo0l{oEE?kqEHs`+W1w~TY;7l!e| zw$BlG^N>S?L*6F;9x^DPE#ot6Wx?t3Gw#i?vwAt4-kXpEER-thz&!zat4dR!Z_dKd zc^>cLkd7zSXsH$;DUcA&`F8g1hYp_S={~6M=Gy6=2fVx6UcPV#16Qn$x`M6jr@5ji zPr2Sfn4Z_81!3hGfLUt5>fT#)ZrBD1)M#Oa4ce5XLfcIOtv& zYpBkz5=7}8AM?ovF_+>OUnu)(MSzbP;M+Un`2@}GOvFGsLvW-?67h1&|Lstvk!;1} z{RT4-_J(|SAH$Ij>Dl*p+Me9UjH50s+$_DtIIDh}#Q$6VK=H0r3jjsT5R4P?-mC>_ z$QZH_3pado3AVp*7a^)re)ugnuMriaRH^1tSqt4DT+b<&TI49d5Bk)GI*~khPa|!t z4_Ksw95x%}rl`7YB_rca;n4)<_w{Lqb$CmFybfp6U3jSnJy@lp^-Uc3(OLgZe1*@R zx$d$K&I=F(+NnJV--x+#fpA&G<#V0H_@F_}SS+rB%K+WkF@*&MJ@95{iyJ|Yq%3^a z99Udk_@Rz(s+fyT(8(4RiCL-N>*QoiZ%?}K5^0PBg-|yiZ#C{z*u_cQp|0w&T>7;q z8xdX1j;R`6QDJoUIzmSu6B9KV`?x4mguLOz5BF%iVhoUE?1>)IIVorFyIjZ9iXig> zn}<DI?_L#!d#ify;H7SbtIAx-Q@z4j*=2J}>d*W`76 z|AWuhf6m@K>2KH;I2_!5#%v2^L%vHdnC13sL02O|?GEU@#zBC5@Njt)Uy3(;vI2VL zQxy?#nB~xX7LI}=CxSxni*%8nd<~tHf37Z^qmnyLtLfM`Hbz-V-qH4$dw>7lOX`<= zO_+XJ+XRl~XHP{a&^5s<3x|g}E+K4?9RVFPsqZtFa>tJjr%o21jVe^@(v+%{*$RXM zAjv0sQ-ohz(2~{;DS>@Xku?aPNj$+vqy^Q&?Gqr{)-(=g9W@U>cFe{mmH)8zU*v75 zSW;xX-(+IL0Z~e;YlWnmCa`hO;t>?yP``3Dfi}w!!2H`@iqm!Za792EZP+47kdm;e z5}SB#`68wwP>7a{-pcWXPGzC}7($#cXpQ8l+Lq!hf4-=V2+30zS5hl+<57dAIZ&GKtt)-Gkd6aN^~vk>}mO zvIR-13qWyCjj~h9!(HJ76;5SMj?8%dlVW3Ke-x(ntYY+at46*|1C$CTw1nH0*RTPTbE-@ z{DK=xUH8$gjmF8`xiu?R_`E)!4bgEHS44{9@ixKmQ96{83;3ksQr=(sS87Hjn25_H z5V9PP3&DtOKZHi77RK3LP#!Y(ENIFpt{Y?=o*9?2BtRBY!Cg9?&;Uw4+xdy2{+;+h zm_0#b002_zD8Gd1FgC(HM|b2S)N1qPWIR88tL1M`j!~sqi@i|6v=(W)i5xj+g->H~ zXQ#WO{i9aVa@k07nHd88kMf)>oSpLd@?PiEW`5k~72G13NQ(O@KY=@Q{7)KISfz!i zZ?{44PE(-=d7}AjZGRjYa=N0-h#SYCqjis1;&*I{pq>}TC?+2-8{!{((wh8S0}o6; zee$@9lYXG@jCdyd+xius8UfkcQ^Jo}#BZQ!7PrJt**oAxdS(t*(4UvnSBY;6!32^! zv-DMGq1(OUL#Iw^sq1EH=FK8d2s~?0m^T7i(fN^UpBHc_m>0-|>C3|yT3whcYi#zk z^Uts*esO^nmSoW~9~@{U+Gfu?F?->1GWX2m1ZhQPOCLdE? z8y^{t@(^b6)92CrFO;Fk?g4F|A$wsP7N_vmN|?73VuP}S+z<%MkHi?u*o_}Cx$SFT zi+3J(yG5u^Qeo%_6J-Rr*63kVEoY~Py%y-i4#UT1V$dndgeH1J7oh5@T1V8v??E3^ zFSV*{npKkv2W`9WON!&fUj#WeEck0zoE)Py7Iq4&{veuq=>pSfM+@Lz*;+UJNb)2o zv^*a30VJO2BGVl%a8UtSQ|^6N-FFXIuT#Lib6QJ{-G*$Nr-&JaCF z)9N$6T_R#4yr&rvP~IsK*LyjA4jQrbxPTf`*pAuQbtvqBhip4!9!~`P+5WIKcHIRb z?D%X~l!7s*2W)!1Om^#|Y8+sp01*5Lzq;HD&*Rm)ondg=Je?)S=4o+wKchc``El^# zFw1aBpKZ^tE076dgM>@kQ~IJupnJ?g~Sn(nEn| z4PNSbi0rRMH#(oL3b(}F@c98WWUFKGZEHyz=(~AOoQ%q6EQu6~J3d-Ur}t5OWs2N6 zBmhL=eMNz1;(tURJ8Rc!SMo~Pq1DHiMpEHCh+QgzTokGQ*cuSr3Ms837kmW|$X_jp zF1#?OGNc-Y70ZJKsGor1RwhX8*Bx$C-_-*Gc=+;47c829_2Q&HETwaP_%Z}1VY@K> zpGb>Krt|u%#M39h0^Nla$+W@0(i={I*3?vAe_HAsW0M90 z6vJPrfrzTpMJ3mHCJy6)8P>Maiu>1b!ggky>yUKAixR*OT$2orHoH*O)osV(O9f5V zdCh_7j!IF4XyD0_2!W=aFQV^k`~Z8+9_KZgpqp$F1U1eOu}aWn)*ExOnG>11h_j3;AL?Fx8e(+eQnPvV=523o&Fu!(M zk2|nR^UqGM#eWZdMn2CYv%|Mg>|Mb7bail+{{Ri2=ejtJC!VxqHb~7oCA4$Y0P;x| zj5eCiRy_K3vPmYrLxVp+E$t)fh2NkM8akFtz=BM$-NXNL_cl97joqA`Y<7wN!v(H7 zS0J4z5U?bg+DNkKkg;EFXf*P?6F>X4UOe7lID&8$<)IYGDk)uVn`jZ3M=CR1I(UpH zName^=LF7oHlg?sI^Q*4}YxSDVAgo+6R8K*3{m2>g+dT%b)0J2>i$+z;9vo!-gX5i_uc*C2hv8)Fs} zywi;DxSPi=hRf%pTwji5VAg)6rs(33oR!2A4a|cbsr3-_dDWKR`^H@HmQ~EglV=bW!oq3xyW&&x7IS)w6cPY(_I? z)J!5Nxl;WjRYZ$t6JN)rdV4bQI~PE}<_35z{Oa?KhAkGPIRo%&o3>{-8IVnE8-Yh# z0}K_=Pt!gFjwHkUns;?b^TVyysKf_FVV|EXI23&4) z7`LoEa;<1HxAd^HZOrIXDmNdhtRm2`Bmd{+;XjD%@z|3WQ7@ie{9<>w3A0(LiqYjNLtJVIf~80ShSwl`vL|2x615zuMzvjp$Vd&2fSr z^2bVU{F#!p09_7`5Zu}zq+dlr8vJL|lAbP{$u|eMv@Jio|F!vrqszmK@_oH#Uamo? z(8p;P$@y<6CrE#HUaw&}o#3ss0eS_Y}s56`Vp~;yvqEuFa4qfMN<_`r8v zCF12VmmF13tS0emd3pA^)LeacLtd9eJoi9$KyPYQ8yAXZ+DU))1IE%*8(@K^j4GLI zjWqmx=~RoiKKb{8S-76A6h=Mm-KaZ9oP>v%{Qn6t|>{USPj(!hZ*pum3ySnVK3K21P%q@bODJWaVZa$UWaMX#Ixaig|+WK-2*;cM};#F7hqc}ve)ib7-QI)#70%y)mlwXw#1td!^ z&jqDl>@LLkbvZVXHXT$s8XzHbmdC-`e2|Y5;GPkm6YuM2_31?D2c4?I=4}G^mnY%< z$4)Ga9KwK!!r)_N%Qy4_snS^pV#us2W79XsT8%tjl+>^FFShF%fmWm?t=G?>BGeH4 z^rg-3+oFfMKOP}Qo5Y|7apB0ot}QUmV*Y+L;9rJ&IPFG#j#Wuaj!JFM#h&P zkWzzF@0C+=Lzl2_N^rKj0x)-?Nz23_;;z;~h(%wrY5pe)!nc^4E-O1v-Sa$&_X59t z#`x4y-oX!K7F$8F%P#uWV+Z3B9}qE>8Ihe7VXQ?(!oTp*!Swh{R|{~tO1r}TA6Pf% z{M%5R*Zu(*O4uU%LkY}YaT8%XyXY?|lRl`@hy%Nn>N+um&;4+ttm&!0fku%aZ-|F; z@txgjO3(~5n+E)(SFGY*2J3*HJN1o~7j;ZO(%R>HrY|GKi!z5p)Zm`j0cus9JSwgJ zSnfdARqfAxZ;}yzeGODjU&s*aiYX#``H%;$3|+!aPhN)(S(hw4Ssd#m*z=x3YOc@h zR{|-4zRBL~oT7aum7-Vxd}-^VbP>f53DbkXb7(1vN}uwcaFrEg5h>X*G>Spuhrh{3 zhJjCg&KjDyle-HwMod2pzs^v%H}<7#`8%JYf*{<>--HVQ;1ViDOvYl%$gY|Qyam}P z`b;y&_2A`eZK8$Ln+tJZdcw{U+!6>q-Hz@wI}B{LhvmIE<97r3M)@knz(CNw;=K&X znM(>ijF%@5ZmthXk4*70)kHbZS}J$7XPCa9t3(L+i@*$9WtK7$dn59^c>2)zwe%X$ zkGoJd!rO8~IKBcZBs>=!x4`pYAH#fB=UPh0WLz3Oea&fae8v4aleTPC%20`uWMa+4 z5SD&CG%ooEmTK)$Pssoinom?$u}=APQS!Zs9FG)T9Wrv4oXcUv=#` zD1)B@

o+OsgLrq&waQa5BY$E4DHDf@QYKQj(44n7sh(Gx~c8#s(_QGu7<#?%znS z<-xGsPN#=+LejW+Hxc$d!3`8LrAK)E!DWKCS1Xgy9rM3WXT;|0H8#R^M$-sLW@;@i zb;WwvAEA6eX6C%>{A-_cCQJ|KiLhY6dY_ze7K!*=>JEn{Upth?_3|@)jhln2ukd)j z0xTu$iP$-2(=m*C>ZRi7adKw`_CoXd@6|X-!R%@c$F(=`V?)nkr1-mz*gKGQxIGW% zIL2@Ct@}(XWGy-PtJMf&#v$;4)7k`PKg7XQUm2LiZZe+2x#bE)dqXFQ&E5CSVy7Qj zRCwz~>D3)}L@{;$n}F`0ji4ke#a- zbG?eb)5Z71)<;aP0twCoL|z04q72f@CYZSVLKKCymNJbVsfxv&M2Hn1O0ad6dFR9x zM<%pCYZ4W1HuE;fMOIrbkQk-A_o>M9`Kf2q#oC}@Fs!k@sk8RhyOuIftn($Xf0)b^ zI`udRrDo9IWP`9PXJ@1!p;G9{1^wDb)An6W(r(2W=(vG1JJJ`BO6M?_QiGwr802?c zn3BoBz0P^ZUwNee80qNSo^Z_iu~fbMyf&j0H^g$qntlxFK$rz% zxJznruE+|0cPSP??2!?6d9OgoHa`9#e#niEH?|00@A85X9X*vE0EhRINO-=^I;DK? zQglXho=`%jLZushzc&m200aypp3|@m&N9EW1 zA>`*F>bxF5s@|zy8kc92ZGEn;+dlpU~c|h|$>Nx8c z$kn=pYWdUQ<${YB{Eq~2fJ3o+sx86&y#jps1i6OKG~ox)+|tq^04u%4sNsvt+W}B) z0!ncU*%`Xy$sz#Bcf{HvDpMM!Aj%O6LjBJjew#>jPBol0-DJh-tFgofq9ki+26RF zG4%R_ML$QqTI;Jmy5o3NSmNoo?w3i18QOTFT>%*gAu;q^C#7h;T!fB^VBW-745Ha|XYUAPPi_CIvfq9;ggu zCWWKr2E4V+qaSJ*5iZb7zR0PXS_JS$#?kUTf&tmM<2S+Ty^7Rlb=8dYzP)ObK!>c( zU4#9z&f%-Pxb25Hc+{WXj~kZkAI;WbJ<%_-zWYxYEX0Ri>*U$*MfFxK0Yb34XlqkxN-l}6%BlzBJ^gAxB9*7DR)~pT z(^?ol3v+q<`YAM)fdA8?wn7TPSYbI3DwYKIxHjjwr8e_%nM*rgN{dhH+zn&l8!4Hjmmkz0EUDW7 zTawc%8yV%>qilp=2E}$528hyLALj7(Y}6r%5p1K98R?o|gV*0~ e%$DP<#@2x!bAE|MLRfJrAu;Ctez4Sl!1auVa)0gs diff --git a/AddMSPApp/immy.app.xml b/AddMSPApp/immy.app.xml deleted file mode 100644 index 33c2b026cf06..000000000000 --- a/AddMSPApp/immy.app.xml +++ /dev/null @@ -1,15 +0,0 @@ - - install.ps1 - 701 - IntunePackage.intunewin - install.ps1 - - doCFlu6eR0FygwmKEt64S1Yd8DBfok8/l0ophT7m2R4= - 5ai/8f238719rpGrOigf7mjx5u+gF6cBTOLWMBx5lrY= - klnIk9zH1fNeekrILt3tLw== - 9vyw/gMTsEsx3o3TVapXLxUQooNlVMRQj5/cXTo77x0= - ProfileVersion1 - 1eS5ExzbAFPOfI8x9REbwff0RAy5gvjTxYNZdAKUDcc= - SHA256 - - \ No newline at end of file diff --git a/AddMSPApp/immy.intunewin b/AddMSPApp/immy.intunewin deleted file mode 100644 index 5102fd736f7565e0d5786f6065da7e74cf40b081..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 752 zcmVMH z-R&4UTZ^)p&{3Ct-0mb;bz-7e zC93!SN_vMjmVdi61hH;iz4)J-ahd=_QL-4S;F`rbB~_1}Xo|cGABKpw|9}B15+49F zFSUolGHlzB*#(D2v6&|LU#X}MMe)7*mpNA7&vK0pXX)o#3hVb&5DOyYUgTpp3nKxo zlyu((V$)@C7eZ@PtL!jIFqF)P5C`15L%ly;cxZ}m^Z7Fip0#kfhr@Ft+e;kPdSct# zVbU2WSzBIBAz0kjZVf93ZUOy^b~kHA1%w72sQ>DiIc9U*D<{kM3udq)2mC{z;jv*< z|88UrY%TLK-P~t&u2lk35T3=p7)g%(xZ8yMpjXtjF4Z7ot!=F1(=MH6MXzi^*StL; zWNYqpuzj@YW=-=-LIxFZ|f>1HzE}W_(j{{1upDD3iT2;Q5?o+f;CsEyt#^u9J`26L`s~O$71&*v6t0!w_ zc1XT1+b7yj*17J<^_}wmt;4lbD8L3zsX78`*-8-$BSJF-@pt%A+_A#E>(@Y8KR5H! i(ON7ANGQ#Q_PYN7BTz~6PSnktbtC5+o);rImGo)`d~uWj diff --git a/AddMSPApp/ninjarmm.app.json b/AddMSPApp/ninjarmm.app.json deleted file mode 100644 index 5cd567eaf210..000000000000 --- a/AddMSPApp/ninjarmm.app.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "displayName": "", - "installCommandLine": "", - "uninstallCommandLine": "", - "description": " ", - "developer": " ", - "owner": " ", - "informationUrl": " ", - "privacyInformationUrl": " ", - "fileName": "ninjarmm.intunewin", - "@odata.type": "#microsoft.graph.win32LobApp", - "applicableArchitectures": "x86, x64", - - "installExperience": { - "runAsAccount": "system", - "deviceRestartBehavior": "suppress", - "@odata.type": "microsoft.graph.win32LobAppInstallExperience" - }, - "detectionRules": [ - { - "@odata.type": "#microsoft.graph.win32LobAppFileSystemDetection", - "path": "%ProgramData%\\Syncro\\Bin", - "fileOrFolderName": "Syncro.Overmind.Service.exe", - "check32BitOn64System": false, - "detectionType": "exists" - } - ], - "returncode": [ - { - "returnCode": 0, - "type": "success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1707, - "type": "Success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1641, - "type": "hardReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1618, - "type": "retry", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 3010, - "type": "softReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - } - ], - "minimumNumberOfProcessors": "1", - "minimumFreeDiskSpaceInMB": "8", - "minimumCpuSpeedInMHz": "4", - "minimumSupportedOperatingSystem": { - "@odata.type": "microsoft.graph.windowsMinimumOperatingSystem", - "v10_1607": true - }, - "notes": "CIPP Uploaded application", - "minimumMemoryInMB": "1" -} diff --git a/AddMSPApp/ninjarmm.app.xml b/AddMSPApp/ninjarmm.app.xml deleted file mode 100644 index 647d26712e8b..000000000000 --- a/AddMSPApp/ninjarmm.app.xml +++ /dev/null @@ -1,15 +0,0 @@ - - install.ps1 - 728 - syncro.intunewin - install.ps1 - - XsBprXNg7cPsNS7YfRarT1zcSoL6/EF+c2dAjkhfuwk= - c4xkRYZg/r/h1xUD1172Tmr877nDXIoa3wuQnj0dpLQ= - OE7D78wJtXIpVESqaZAiWw== - 2m0nbXMdYK9dQgtjZraz3VsSxQlbO0jabpTaUjPg8I8= - ProfileVersion1 - gPccLH2ZAerHl8aYGYTxWmC8mnpJncTKBw5BX4IpH+g= - SHA256 - - \ No newline at end of file diff --git a/AddMSPApp/syncro.app.json b/AddMSPApp/syncro.app.json deleted file mode 100644 index 1d5f0e01fb4b..000000000000 --- a/AddMSPApp/syncro.app.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "displayName": "", - "installCommandLine": "", - "uninstallCommandLine": "", - "description": " ", - "developer": " ", - "owner": " ", - "informationUrl": " ", - "privacyInformationUrl": " ", - "fileName": "syncro.intunewin", - "@odata.type": "#microsoft.graph.win32LobApp", - "applicableArchitectures": "x86, x64", - - "installExperience": { - "runAsAccount": "system", - "deviceRestartBehavior": "suppress", - "@odata.type": "microsoft.graph.win32LobAppInstallExperience" - }, - "detectionRules": [ - { - "@odata.type": "#microsoft.graph.win32LobAppFileSystemDetection", - "path": "%ProgramData%\\Syncro\\Bin", - "fileOrFolderName": "Syncro.Overmind.Service.exe", - "check32BitOn64System": false, - "detectionType": "exists" - } - ], - "returncode": [ - { - "returnCode": 0, - "type": "success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1707, - "type": "Success", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1641, - "type": "hardReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 1618, - "type": "retry", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - }, - { - "returnCode": 3010, - "type": "softReboot", - "@odata.type": "#microsoft.graph.win32LobAppReturnCode" - } - ], - "minimumNumberOfProcessors": "1", - "minimumFreeDiskSpaceInMB": "8", - "minimumCpuSpeedInMHz": "4", - "minimumSupportedOperatingSystem": { - "@odata.type": "microsoft.graph.windowsMinimumOperatingSystem", - "v10_1607": true - }, - "notes": "CIPP Uploaded application", - "minimumMemoryInMB": "1", - "setupFilePath": "install.ps1" -} diff --git a/AddMSPApp/syncro.app.xml b/AddMSPApp/syncro.app.xml deleted file mode 100644 index 647d26712e8b..000000000000 --- a/AddMSPApp/syncro.app.xml +++ /dev/null @@ -1,15 +0,0 @@ - - install.ps1 - 728 - syncro.intunewin - install.ps1 - - XsBprXNg7cPsNS7YfRarT1zcSoL6/EF+c2dAjkhfuwk= - c4xkRYZg/r/h1xUD1172Tmr877nDXIoa3wuQnj0dpLQ= - OE7D78wJtXIpVESqaZAiWw== - 2m0nbXMdYK9dQgtjZraz3VsSxQlbO0jabpTaUjPg8I8= - ProfileVersion1 - gPccLH2ZAerHl8aYGYTxWmC8mnpJncTKBw5BX4IpH+g= - SHA256 - - \ No newline at end of file diff --git a/AddMSPApp/syncro.intunewin b/AddMSPApp/syncro.intunewin deleted file mode 100644 index 1cf9f0ef8c66400b340846306c7324c537f70946..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 784 zcmV+r1MmFWZ6|GW9bm6rLJMPNwzJ(^62%EyJ4o7Yl-g1=;P8()PQ&la3AJ)5R79$2 zkRn@R!GFs*LSB|kkZF+_kLfesgajT?{A)s+D!)wW?O@Enes$38oebJR*IFyJ?*rvIO?Q3m9fKxK$lDl_Z{Tn0;J< zAr7VMw5rWr<4mbt1eA0Bt$4E_l~VLe4knQMkLs1?{&nlSk%B*ALNm~na)`llNhDL8 zv)9`zh^j{(BO#*k0V=X}Ar2l^AyYtUFiq5?b%;jkyqf>AQxx#?#Iu&W_?(jIdP@8P zhZ-(QGII?VQJusVHMJf1o+MoD54s@%)x zd3HQT&nyXxRPca57c{ArrGS@0An@Q^+JD1jEAKezRu87619Jk2-nLC`@0!tRWJM?- z%bDKeymJ0fQVegx(T-1SJ3#i?WCV@k4$ni?F>X2HGhUj*Bfc#>k67DRF}#^+D+?;H ziKg1eBsr_;9PQE7)-FUlki$Df^y1tEj?D$MPEgwCnE8P|t32-bc2kv(fr7&+*x?sQ zDvD5wH$mmPwKqjoSO0GlQK_TigHV*a-ZEJaRWveeE^rRz-ihx2#mm_Kn|EM=yonqb z_q9jLx+_+4Cmv>B_gP-&bUPKRld1uu*q7sGImb!RYFkYhq2*{@3(2yBA?K}|)%DWaUc6TY OuT%rHS!sGZ@5QMjzlw|i diff --git a/Applications_GetQueue/function.json b/Applications_GetQueue/function.json deleted file mode 100644 index b31f1ad21352..000000000000 --- a/Applications_GetQueue/function.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "bindings": [ - { - "name": "name", - "type": "activityTrigger", - "direction": "in" - } - ] -} \ No newline at end of file diff --git a/Applications_GetQueue/run.ps1 b/Applications_GetQueue/run.ps1 deleted file mode 100644 index 44940eed384b..000000000000 --- a/Applications_GetQueue/run.ps1 +++ /dev/null @@ -1,6 +0,0 @@ -param($name) - -$Table = Get-CippTable -tablename 'apps' - -$Object = (Get-CIPPAzDataTableEntity @Table).RowKey -$object \ No newline at end of file diff --git a/Applications_Orchestrator/function.json b/Applications_Orchestrator/function.json deleted file mode 100644 index 7326b39c184d..000000000000 --- a/Applications_Orchestrator/function.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "bindings": [ - { - "name": "Context", - "type": "orchestrationTrigger", - "direction": "in" - } - ] -} \ No newline at end of file diff --git a/Applications_Orchestrator/run.ps1 b/Applications_Orchestrator/run.ps1 deleted file mode 100644 index ebf60eb55628..000000000000 --- a/Applications_Orchestrator/run.ps1 +++ /dev/null @@ -1,25 +0,0 @@ -param($Context) - -$DurableRetryOptions = @{ - FirstRetryInterval = (New-TimeSpan -Seconds 5) - MaxNumberOfAttempts = 3 - BackoffCoefficient = 2 -} -$RetryOptions = New-DurableRetryOptions @DurableRetryOptions - -try { - $Batch = (Invoke-ActivityFunction -FunctionName 'Applications_GetQueue' -Input 'LetsGo') - Write-Host $Batch - $ParallelTasks = foreach ($Item in $Batch) { - Invoke-DurableActivity -FunctionName 'Applications_Upload' -Input $item -NoWait -RetryOptions $RetryOptions - } - - $Outputs = Wait-ActivityFunction -Task $ParallelTasks - Write-Host $Outputs -} -catch { - Write-Host "Applications_Orchestrator exception: $($_.Exception.Message)" -} -finally { - Write-LogMessage -API 'ChocoApp' -Message 'Choco Application Queue: Deployment finished.' -sev Info -} \ No newline at end of file diff --git a/Applications_Upload/function.json b/Applications_Upload/function.json deleted file mode 100644 index b31f1ad21352..000000000000 --- a/Applications_Upload/function.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "bindings": [ - { - "name": "name", - "type": "activityTrigger", - "direction": "in" - } - ] -} \ No newline at end of file diff --git a/Applications_Upload/run.ps1 b/Applications_Upload/run.ps1 deleted file mode 100644 index 9245bf78f2f5..000000000000 --- a/Applications_Upload/run.ps1 +++ /dev/null @@ -1,121 +0,0 @@ -param($name) -$Table = Get-CippTable -tablename 'apps' -$Filter = "PartitionKey eq 'apps' and RowKey eq '$name'" -Set-Location (Get-Item $PSScriptRoot).Parent.FullName -$ChocoApp = (Get-CIPPAzDataTableEntity @Table -filter $Filter).JSON | ConvertFrom-Json -$intuneBody = $ChocoApp.IntuneBody -$tenants = if ($chocoapp.Tenant -eq 'AllTenants') { - (Get-tenants).defaultDomainName -} else { - $chocoapp.Tenant -} -if ($chocoApp.type -eq 'MSPApp') { - [xml]$Intunexml = Get-Content "AddMSPApp\$($ChocoApp.MSPAppName).app.xml" - $intunewinFilesize = (Get-Item "AddMSPApp\$($ChocoApp.MSPAppName).intunewin") - $Infile = "AddMSPApp\$($ChocoApp.MSPAppName).intunewin" -} else { - [xml]$Intunexml = Get-Content 'AddChocoApp\choco.app.xml' - $intunewinFilesize = (Get-Item 'AddChocoApp\IntunePackage.intunewin') - $Infile = "AddChocoApp\$($intunexml.ApplicationInfo.FileName)" -} -$assignTo = $ChocoApp.AssignTo -$AssignToIntent = $ChocoApp.InstallationIntent -$Baseuri = 'https://graph.microsoft.com/beta/deviceAppManagement/mobileApps' -$ContentBody = ConvertTo-Json @{ - name = $intunexml.ApplicationInfo.FileName - size = [int64]$intunexml.ApplicationInfo.UnencryptedContentSize - sizeEncrypted = [int64]($intunewinFilesize).length -} -$ClearRow = Get-CIPPAzDataTableEntity @Table -Filter $Filter -$RemoveCacheFile = if ($chocoapp.Tenant -ne 'AllTenants') { - Remove-AzDataTableEntity @Table -Entity $clearRow -} else { - $Table.Force = $true - Add-CIPPAzDataTableEntity @Table -Entity @{ - JSON = "$($ChocoApp | ConvertTo-Json)" - RowKey = "$($ClearRow.RowKey)" - PartitionKey = 'apps' - status = 'Deployed' - } -} -$EncBody = @{ - fileEncryptionInfo = @{ - encryptionKey = $intunexml.ApplicationInfo.EncryptionInfo.EncryptionKey - macKey = $intunexml.ApplicationInfo.EncryptionInfo.MacKey - initializationVector = $intunexml.ApplicationInfo.EncryptionInfo.InitializationVector - mac = $intunexml.ApplicationInfo.EncryptionInfo.Mac - profileIdentifier = $intunexml.ApplicationInfo.EncryptionInfo.ProfileIdentifier - fileDigest = $intunexml.ApplicationInfo.EncryptionInfo.FileDigest - fileDigestAlgorithm = $intunexml.ApplicationInfo.EncryptionInfo.FileDigestAlgorithm - } -} | ConvertTo-Json - -foreach ($tenant in $tenants) { - Try { - - $ApplicationList = (New-graphGetRequest -Uri $baseuri -tenantid $Tenant) | Where-Object { $_.DisplayName -eq $ChocoApp.ApplicationName } - if ($ApplicationList.displayname.count -ge 1) { - Write-LogMessage -api 'AppUpload' -tenant $($Tenant) -message "$($ChocoApp.ApplicationName) exists. Skipping this application" -Sev 'Info' - continue - } - if ($chocoApp.type -eq 'WinGet') { - Write-Host 'Winget!' - Write-Host ($intuneBody | ConvertTo-Json -Compress) - $NewApp = New-GraphPostRequest -Uri $baseuri -Body ($intuneBody | ConvertTo-Json -Compress) -Type POST -tenantid $tenant - Start-Sleep -Milliseconds 200 - Write-LogMessage -api 'AppUpload' -tenant $($Tenant) -message "$($ChocoApp.ApplicationName) uploaded as WinGet app." -Sev 'Info' - if ($AssignTo -ne 'On') { - $intent = if ($AssignToIntent) { 'Uninstall' } else { 'Required' } - Set-CIPPAssignedApplication -ApplicationId $NewApp.Id -Intent $intent -TenantFilter $tenant -groupName "$AssignTo" -AppType 'WinGet' - } - Write-LogMessage -api 'AppUpload' -tenant $($Tenant) -message "$($ChocoApp.ApplicationName) Successfully created" -Sev 'Info' - exit 0 - } else { - $NewApp = New-GraphPostRequest -Uri $baseuri -Body ($intuneBody | ConvertTo-Json) -Type POST -tenantid $tenant - - } - $ContentReq = New-GraphPostRequest -Uri "$($BaseURI)/$($NewApp.id)/microsoft.graph.win32lobapp/contentVersions/1/files/" -Body $ContentBody -Type POST -tenantid $tenant - do { - $AzFileUri = New-graphGetRequest -Uri "$($BaseURI)/$($NewApp.id)/microsoft.graph.win32lobapp/contentVersions/1/files/$($ContentReq.id)" -tenantid $tenant - if ($AZfileuri.uploadState -like '*fail*') { break } - Start-Sleep -Milliseconds 300 - } while ($AzFileUri.AzureStorageUri -eq $null) - Write-Host "Uploading file to $($AzFileUri.azureStorageUri)" - Write-Host "Complete AZ file uri data: $($AzFileUri | ConvertTo-Json -Depth 10)" - $chunkSizeInBytes = 4mb - [byte[]]$bytes = [System.IO.File]::ReadAllBytes($($intunewinFilesize.fullname)) - $chunks = [Math]::Ceiling($bytes.Length / $chunkSizeInBytes) - $id = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($chunks.ToString('0000'))) - #For anyone that reads this, The maximum chunk size is 100MB for blob storage, so we can upload it as one part and just give it the single ID. Easy :) - $Upload = Invoke-RestMethod -Uri "$($AzFileUri.azureStorageUri)&comp=block&blockid=$id" -Method Put -Headers @{'x-ms-blob-type' = 'BlockBlob' } -InFile $inFile -ContentType 'application/octet-stream' - Write-Host "Upload data: $($Upload | ConvertTo-Json -Depth 10)" - $ConfirmUpload = Invoke-RestMethod -Uri "$($AzFileUri.azureStorageUri)&comp=blocklist" -Method Put -Body "$id" - Write-Host "Confirm Upload data: $($ConfirmUpload | ConvertTo-Json -Depth 10)" - $CommitReq = New-graphPostRequest -Uri "$($BaseURI)/$($NewApp.id)/microsoft.graph.win32lobapp/contentVersions/1/files/$($ContentReq.id)/commit" -Body $EncBody -Type POST -tenantid $tenant - Write-Host "Commit Request: $($CommitReq | ConvertTo-Json -Depth 10)" - - do { - $CommitStateReq = New-graphGetRequest -Uri "$($BaseURI)/$($NewApp.id)/microsoft.graph.win32lobapp/contentVersions/1/files/$($ContentReq.id)" -tenantid $tenant - Write-Host "Commit State Request: $($CommitStateReq | ConvertTo-Json -Depth 10)" - if ($CommitStateReq.uploadState -like '*fail*') { - Write-LogMessage -api 'AppUpload' -tenant $($Tenant) -message "$($ChocoApp.ApplicationName) Commit failed. Please check if app uploaded succesful" -Sev 'Warning' - break - } - Start-Sleep -Milliseconds 300 - } while ($CommitStateReq.uploadState -eq 'commitFilePending') - $CommitFinalizeReq = New-graphPostRequest -Uri "$($BaseURI)/$($NewApp.id)" -tenantid $tenant -Body '{"@odata.type":"#microsoft.graph.win32lobapp","committedContentVersion":"1"}' -type PATCH - Write-Host "Commit Finalize Request: $($CommitFinalizeReq | ConvertTo-Json -Depth 10)" - Write-LogMessage -api 'AppUpload' -tenant $($Tenant) -message "Added Application $($chocoApp.ApplicationName)" -Sev 'Info' - if ($AssignTo -ne 'On') { - $intent = if ($AssignToIntent) { 'Uninstall' } else { 'Required' } - Set-CIPPAssignedApplication -ApplicationId $NewApp.Id -Intent $intent -TenantFilter $tenant -groupName "$AssignTo" -AppType 'Win32Lob' - - } - Write-LogMessage -api 'AppUpload' -tenant $($Tenant) -message 'Successfully added Application' -Sev 'Info' - } catch { - "Failed to add Application for $($Tenant): $($_.Exception.Message)" - Write-LogMessage -api 'AppUpload' -tenant $($Tenant) -message "Failed adding Application $($ChocoApp.ApplicationName). Error: $($_.Exception.Message)" -LogData (Get-CippException -Exception $_) -Sev 'Error' - continue - } - -} diff --git a/BestPracticeAnalyser_OrchestrationStarter/function.json b/BestPracticeAnalyser_OrchestrationStarter/function.json deleted file mode 100644 index 14c44f4f0217..000000000000 --- a/BestPracticeAnalyser_OrchestrationStarter/function.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "bindings": [ - { - "authLevel": "anonymous", - "name": "Request", - "type": "httpTrigger", - "direction": "in", - "methods": [ - "post", - "get" - ] - }, - { - "type": "http", - "direction": "out", - "name": "Response" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/BestPracticeAnalyser_OrchestrationStarter/run.ps1 b/BestPracticeAnalyser_OrchestrationStarter/run.ps1 deleted file mode 100644 index 3135509f9b3e..000000000000 --- a/BestPracticeAnalyser_OrchestrationStarter/run.ps1 +++ /dev/null @@ -1,40 +0,0 @@ -using namespace System.Net -param($Request, $TriggerMetadata) - -if ($Request.Query.TenantFilter) { - $TenantList = @($Request.Query.TenantFilter) - $Name = "Best Practice Analyser ($($Request.Query.TenantFilter))" -} else { - $TenantList = Get-Tenants - $Name = 'Best Practice Analyser (All Tenants)' -} - -$BPATemplateTable = Get-CippTable -tablename 'templates' -$Filter = "PartitionKey eq 'BPATemplate'" -$Templates = ((Get-CIPPAzDataTableEntity @BPATemplateTable -Filter $Filter).JSON | ConvertFrom-Json).Name - -$BPAReports = foreach ($Tenant in $TenantList) { - foreach ($Template in $Templates) { - [PSCustomObject]@{ - FunctionName = 'BPACollectData' - Tenant = $Tenant.defaultDomainName - Template = $Template - QueueName = '{0} - {1}' -f $Template, $Tenant.defaultDomainName - } - } -} - -$Queue = New-CippQueueEntry -Name $Name -TotalTasks ($BPAReports | Measure-Object).Count -$BPAReports = $BPAReports | Select-Object *, @{Name = 'QueueId'; Expression = { $Queue.RowKey } } -$InputObject = [PSCustomObject]@{ - Batch = @($BPAReports) - OrchestratorName = 'BPAOrchestrator' - SkipLog = $true -} -Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Compress -Depth 5) - -$Results = [pscustomobject]@{'Results' = 'BPA started' } -Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{ - StatusCode = [HttpStatusCode]::OK - Body = $Results - }) \ No newline at end of file diff --git a/BestPracticeAnalyser_OrchestrationStarterTimer/function.json b/BestPracticeAnalyser_OrchestrationStarterTimer/function.json deleted file mode 100644 index cbdf59ee8bba..000000000000 --- a/BestPracticeAnalyser_OrchestrationStarterTimer/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "type": "timerTrigger", - "direction": "in", - "schedule": "0 0 3 * * *" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} \ No newline at end of file diff --git a/BestPracticeAnalyser_OrchestrationStarterTimer/run.ps1 b/BestPracticeAnalyser_OrchestrationStarterTimer/run.ps1 deleted file mode 100644 index 0b9faa0a7c8b..000000000000 --- a/BestPracticeAnalyser_OrchestrationStarterTimer/run.ps1 +++ /dev/null @@ -1,33 +0,0 @@ -param($Timer) - -if ($env:DEV_SKIP_BPA_TIMER) { - Write-Host 'Skipping BPA timer' - exit 0 -} - -$TenantList = Get-Tenants - -$BPATemplateTable = Get-CippTable -tablename 'templates' -$Filter = "PartitionKey eq 'BPATemplate'" -$Templates = ((Get-CIPPAzDataTableEntity @BPATemplateTable -Filter $Filter).JSON | ConvertFrom-Json).Name - - -$BPAReports = foreach ($Tenant in $TenantList) { - foreach ($Template in $Templates) { - [PSCustomObject]@{ - FunctionName = 'BPACollectData' - Tenant = $Tenant.defaultDomainName - Template = $Template - QueueName = '{0} - {1}' -f $Template, $Tenant.defaultDomainName - } - } -} - -$Queue = New-CippQueueEntry -Name 'Best Practice Analyser' -TotalTasks ($BPAReports | Measure-Object).Count -$BPAReports = $BPAReports | Select-Object *, @{Name = 'QueueId'; Expression = { $Queue.RowKey } } -$InputObject = [PSCustomObject]@{ - Batch = @($BPAReports) - OrchestratorName = 'BPAOrchestrator' - SkipLog = $true -} -Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Compress -Depth 5) diff --git a/Cache_SAMSetup/PermissionsTranslator.json b/Cache_SAMSetup/PermissionsTranslator.json deleted file mode 100644 index ecc57bd2649d..000000000000 --- a/Cache_SAMSetup/PermissionsTranslator.json +++ /dev/null @@ -1,5350 +0,0 @@ -[ - { - "description": "Allows Exchange Management as app", - "displayName": "Manage Exchange As Application ", - "id": "dc50a0fb-09a3-484d-be87-e023b12c6440", - "origin": "Application (Office 365 Exchange Online)", - "value": "Exchange.ManageAsApp" - }, - { - "description": "Allows the app to read a basic set of profile properties of other users in your organization without a signed-in user. Includes display name, first and last name, email address, open extensions, and photo.", - "displayName": "Read all users' basic profiles", - "id": "97235f07-e226-4f63-ace3-39588e11d3a1", - "origin": "Application", - "value": "User.ReadBasic.All" - }, - { - "description": "Allows the app to read all\u00a0class assignments without grades for all users without a signed-in user.", - "displayName": "Read all class assignments without grades", - "id": "6e0a958b-b7fc-4348-b7c4-a6ab9fd3dd0e", - "origin": "Application", - "value": "EduAssignments.ReadBasic.All" - }, - { - "description": "Allows the app to create, read, update and delete all\u00a0class assignments without grades for all users without a signed-in user.", - "displayName": "Create, read, update and delete all\u00a0class assignments without grades", - "id": "f431cc63-a2de-48c4-8054-a34bc093af84", - "origin": "Application", - "value": "EduAssignments.ReadWriteBasic.All" - }, - { - "description": "Allows the app to read all\u00a0class assignments with grades for all users without a signed-in user.", - "displayName": "Read all class assignments with grades", - "id": "4c37e1b6-35a1-43bf-926a-6f30f2cdf585", - "origin": "Application", - "value": "EduAssignments.Read.All" - }, - { - "description": "Allows the app to create, read, update and delete all\u00a0class assignments with grades for all users without a signed-in user.", - "displayName": "Create, read, update and delete all\u00a0class assignments with grades", - "id": "0d22204b-6cad-4dd0-8362-3e3f2ae699d9", - "origin": "Application", - "value": "EduAssignments.ReadWrite.All" - }, - { - "description": "Allows\u00a0the\u00a0app\u00a0to\u00a0read\u00a0subject\u00a0rights requests\u00a0without a\u00a0signed-in\u00a0user.", - "displayName": "Read\u00a0all subject\u00a0rights requests", - "id": "ee1460f0-368b-4153-870a-4e1ca7e72c42", - "origin": "Application", - "value": "SubjectRightsRequest.Read.All" - }, - { - "description": "Allows\u00a0the\u00a0app\u00a0to\u00a0read\u00a0and\u00a0write subject\u00a0rights requests\u00a0without a signed in user.", - "displayName": "Read\u00a0and\u00a0write\u00a0all subject\u00a0rights requests", - "id": "8387eaa4-1a3c-41f5-b261-f888138e6041", - "origin": "Application", - "value": "SubjectRightsRequest.ReadWrite.All" - }, - { - "description": "Allows the app to read attack simulation and training data for an organization without a signed-in user.", - "displayName": "Read attack simulation data of an organization", - "id": "93283d0a-6322-4fa8-966b-8c121624760d", - "origin": "Application", - "value": "AttackSimulation.Read.All" - }, - { - "description": "Allows custom authentication extensions associated with the app to receive HTTP requests triggered by an authentication event. The request can include information about a user, client and resource service principals, and other information about the authentication.", - "displayName": "Receive custom authentication extension HTTP requests", - "id": "214e810f-fda8-4fd7-a475-29461495eb00", - "origin": "Application", - "value": "CustomAuthenticationExtension.Receive.Payload" - }, - { - "description": "Allows the app to read and write your organization's directory access review default policy without a signed-in user.", - "displayName": "Read and write your organization's directory access review default policy", - "id": "77c863fd-06c0-47ce-a7eb-49773e89d319", - "origin": "Application", - "value": "Policy.ReadWrite.AccessReview" - }, - { - "description": "Allows the app to create groups, read all group properties and memberships, update group properties and memberships, and delete groups. Also allows the app to read and write conversations. All of these operations can be performed by the app without a signed-in user.", - "displayName": "Read and write all groups", - "id": "62a82d76-70ea-41e2-9197-370581804d09", - "origin": "Application", - "value": "Group.ReadWrite.All" - }, - { - "description": "Allows the app to read group properties and memberships, and read\u00a0conversations for all groups, without a signed-in user.", - "displayName": "Read all groups", - "id": "5b567255-7703-4780-807c-7be8301ae99b", - "origin": "Application", - "value": "Group.Read.All" - }, - { - "description": "Allows the app to read your organization's threat submissions and threat submission policies without a signed-in user. Also allows the app to create new threat submissions without a signed-in user.", - "displayName": "Read and write all of the organization's threat submissions", - "id": "d72bdbf4-a59b-405c-8b04-5995895819ac", - "origin": "Application", - "value": "ThreatSubmission.ReadWrite.All" - }, - { - "description": "Allows an app to read Bookings appointments, businesses, customers, services, and staff without a signed-in user. ", - "displayName": "Read all Bookings related resources.", - "id": "6e98f277-b046-4193-a4f2-6bf6a78cd491", - "origin": "Application", - "value": "Bookings.Read.All" - }, - { - "description": "Allows an app to read and write Bookings appointments and customers, and additionally allows reading businesses, services, and staff without a signed-in user. ", - "displayName": "Read and write all Bookings related resources.", - "id": "9769393e-5a9f-4302-9e3d-7e018ecb64a7", - "origin": "Application", - "value": "BookingsAppointment.ReadWrite.All" - }, - { - "description": "Allows the application to read any data from Records Management, such as configuration, labels, and policies without the signed in user.", - "displayName": "Read Records Management configuration,\u00a0labels and policies", - "id": "ac3a2b8e-03a3-4da9-9ce0-cbe28bf1accd", - "origin": "Application", - "value": "RecordsManagement.Read.All" - }, - { - "description": "Allow the application to create, update and delete any data from Records Management, such as configuration, labels, and policies without the signed in user.", - "displayName": "Read and write Records Management configuration, labels and policies", - "id": "eb158f57-df43-4751-8b21-b8932adb3d34", - "origin": "Application", - "value": "RecordsManagement.ReadWrite.All" - }, - { - "description": "Allows the app to read details of delegated admin relationships with customers like access details (that includes roles) and the duration as well as specific role assignments to security groups without a signed-in user.", - "displayName": "Read Delegated Admin relationships with customers", - "id": "f6e9e124-4586-492f-adc0-c6f96e4823fd", - "origin": "Application", - "value": "DelegatedAdminRelationship.Read.All" - }, - { - "description": "Allows the app to manage (create-update-terminate) Delegated Admin relationships with customers and role assignments to security groups for active Delegated Admin relationships without a signed-in user.", - "displayName": "Manage Delegated Admin relationships with customers", - "id": "cc13eba4-8cd8-44c6-b4d4-f93237adce58", - "origin": "Application", - "value": "DelegatedAdminRelationship.ReadWrite.All" - }, - { - "description": "Allows the app to read and manage the Cloud PC role-based access control (RBAC) settings, without a signed-in user. This includes reading and managing Cloud PC role definitions and memberships.", - "displayName": "Read and write all Cloud PC RBAC settings", - "id": "274d0592-d1b6-44bd-af1d-26d259bcb43a", - "origin": "Application", - "value": "RoleManagement.ReadWrite.CloudPC" - }, - { - "description": "Allows the app to read the Cloud PC role-based access control (RBAC) settings, without a signed-in user.", - "displayName": "Read Cloud PC RBAC settings", - "id": "031a549a-bb80-49b6-8032-2068448c6a3c", - "origin": "Application", - "value": "RoleManagement.Read.CloudPC" - }, - { - "description": "Allows the app to read custom security attribute assignments for all principals in the tenant without a signed in user.", - "displayName": "Read custom security attribute assignments", - "id": "3b37c5a4-1226-493d-bec3-5d6c6b866f3f", - "origin": "Application", - "value": "CustomSecAttributeAssignment.Read.All" - }, - { - "description": "Allows the app to read custom security attribute definitions for the tenant without a signed in user.", - "displayName": "Read custom security attribute definitions", - "id": "b185aa14-d8d2-42c1-a685-0f5596613624", - "origin": "Application", - "value": "CustomSecAttributeDefinition.Read.All" - }, - { - "description": "Allows the app to read all external connections without a signed-in user.", - "displayName": "Read all external connections", - "id": "1914711b-a1cb-4793-b019-c2ce0ed21b8c", - "origin": "Application", - "value": "ExternalConnection.Read.All" - }, - { - "description": "Allows the app to read and write all external connections without a signed-in user.", - "displayName": "Read and write all external connections", - "id": "34c37bc0-2b40-4d5e-85e1-2365cd256d79", - "origin": "Application", - "value": "ExternalConnection.ReadWrite.All" - }, - { - "description": "Allows the app to read all external items without a signed-in user.", - "displayName": "Read all external items", - "id": "7a7cffad-37d2-4f48-afa4-c6ab129adcc2", - "origin": "Application", - "value": "ExternalItem.Read.All" - }, - { - "description": "Allows the app to read and write your organization's cross tenant access policies without a signed-in user.", - "displayName": "Read and write your organization's cross tenant access policies", - "id": "338163d7-f101-4c92-94ba-ca46fe52447c", - "origin": "Application", - "value": "Policy.ReadWrite.CrossTenantAccess" - }, - { - "description": "Allows the app to read and write custom security attribute definitions for the tenant without a signed in user.", - "displayName": "Read and write custom security attribute definitions", - "id": "12338004-21f4-4896-bf5e-b75dfaf1016d", - "origin": "Application", - "value": "CustomSecAttributeDefinition.ReadWrite.All" - }, - { - "description": "Allows the app to read and write custom security attribute assignments for all principals in the tenant without a signed in user.", - "displayName": "Read and write custom security attribute assignments", - "id": "de89b5e4-5b8f-48eb-8925-29c2b33bd8bd", - "origin": "Application", - "value": "CustomSecAttributeAssignment.ReadWrite.All" - }, - { - "description": "Allows the app to read and write to all security incidents, without a signed-in user.", - "displayName": "Read and write to all security incidents", - "id": "34bf0e97-1971-4929-b999-9e2442d941d7", - "origin": "Application", - "value": "SecurityIncident.ReadWrite.All" - }, - { - "description": "Allows the app to read all security incidents, without a signed-in user.", - "displayName": "Read all security incidents", - "id": "45cc0394-e837-488b-a098-1918f48d186c", - "origin": "Application", - "value": "SecurityIncident.Read.All" - }, - { - "description": "Allows the app to read and write to all security alerts, without a signed-in user.", - "displayName": "Read and write to all security alerts", - "id": "ed4fca05-be46-441f-9803-1873825f8fdb", - "origin": "Application", - "value": "SecurityAlert.ReadWrite.All" - }, - { - "description": "Allows the app to read all security alerts, without a signed-in user.", - "displayName": "Read all security alerts", - "id": "472e4a4d-bb4a-4026-98d1-0b0d74cb74a5", - "origin": "Application", - "value": "SecurityAlert.Read.All" - }, - { - "description": "Allows the app to read and write eDiscovery objects such as cases, custodians, review sets and other related objects without a signed-in user.", - "displayName": "Read and write all eDiscovery objects", - "id": "b2620db1-3bf7-4c5b-9cb9-576d29eac736", - "origin": "Application", - "value": "eDiscovery.ReadWrite.All" - }, - { - "description": "Allows the app to read eDiscovery objects such as cases, custodians, review sets and other related objects without a signed-in user.", - "displayName": "Read all eDiscovery objects", - "id": "50180013-6191-4d1e-a373-e590ff4e66af", - "origin": "Application", - "value": "eDiscovery.Read.All" - }, - { - "description": "Allows the app to run hunting queries, without a signed-in user.", - "displayName": "Run hunting queries", - "id": "dd98c7f5-2d42-42d3-a0e4-633161547251", - "origin": "Application", - "value": "ThreatHunting.Read.All" - }, - { - "description": "Allow the app to read the management data for Teams devices, without a signed-in user.", - "displayName": "Read Teams devices", - "id": "0591bafd-7c1c-4c30-a2a5-2b9aacb1dfe8", - "origin": "Application", - "value": "TeamworkDevice.Read.All" - }, - { - "description": "Allow the app to read and write the management data for Teams devices, without a signed-in user.", - "displayName": "Read and write Teams devices", - "id": "79c02f5b-bd4f-4713-bc2c-a8a4a66e127b", - "origin": "Application", - "value": "TeamworkDevice.ReadWrite.All" - }, - { - "description": "Allows the app to read and update identity risky service principal for your organization, without a signed-in user.", - "displayName": "Read and write all identity risky service principal information", - "id": "cb8d6980-6bcb-4507-afec-ed6de3a2d798", - "origin": "Application", - "value": "IdentityRiskyServicePrincipal.ReadWrite.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall its own tabs for any user, without a signed-in user.", - "displayName": "Allow the Teams app to manage only its own tabs for all users", - "id": "3c42dec6-49e8-4a0a-b469-36cff0d9da93", - "origin": "Application", - "value": "TeamsTab.ReadWriteSelfForUser.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall its own tabs in any team, without a signed-in user.", - "displayName": "Allow the Teams app to manage only its own tabs for all teams", - "id": "91c32b81-0ef0-453f-a5c7-4ce2e562f449", - "origin": "Application", - "value": "TeamsTab.ReadWriteSelfForTeam.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall its own tabs for any chat, without a signed-in user.", - "displayName": "Allow the Teams app to manage only its own tabs for all chats", - "id": "9f62e4a2-a2d6-4350-b28b-d244728c4f86", - "origin": "Application", - "value": "TeamsTab.ReadWriteSelfForChat.All" - }, - { - "description": "Allows the app to read all risky service principal information for your organization, without a signed-in user.", - "displayName": "Read all identity risky service principal information", - "id": "607c7344-0eed-41e5-823a-9695ebe1b7b0", - "origin": "Application", - "value": "IdentityRiskyServicePrincipal.Read.All" - }, - { - "description": "Allows the app to read and write search configurations, without a signed-in user.", - "displayName": "Read and write your organization's search configuration", - "id": "0e778b85-fefa-466d-9eec-750569d92122", - "origin": "Application", - "value": "SearchConfiguration.ReadWrite.All" - }, - { - "description": "Allows the app to read search configurations, without a signed-in user.", - "displayName": "Read your organization's search configuration", - "id": "ada977a5-b8b1-493b-9a91-66c206d76ecf", - "origin": "Application", - "value": "SearchConfiguration.Read.All" - }, - { - "description": "Allows the app to read online meeting artifacts in your organization, without a signed-in user.", - "displayName": "Read online meeting artifacts", - "id": "df01ed3b-eb61-4eca-9965-6b3d789751b2", - "origin": "Application", - "value": "OnlineMeetingArtifact.Read.All" - }, - { - "description": "Allows the app to create, read, update, and delete apps in the app catalogs without a signed-in user.", - "displayName": "Read and write to all app catalogs", - "id": "dc149144-f292-421e-b185-5953f2e98d7f", - "origin": "Application", - "value": "AppCatalog.ReadWrite.All" - }, - { - "description": "Allows the app to read apps in the app catalogs without a signed-in user.", - "displayName": "Read all app catalogs", - "id": "e12dae10-5a57-4817-b79d-dfbec5348930", - "origin": "Application", - "value": "AppCatalog.Read.All" - }, - { - "description": "Allows the app to manage workforce integrations to synchronize data from Microsoft Teams Shifts, without a signed-in user.", - "displayName": "Read and write workforce integrations", - "id": "202bf709-e8e6-478e-bcfd-5d63c50b68e3", - "origin": "Application", - "value": "WorkforceIntegration.ReadWrite.All" - }, - { - "description": "Allows the app to read all presence information and write activity and availability of all users in the directory without a signed-in user. Presence information includes activity, availability, status note, calendar out-of-office message, time zone and location.", - "displayName": "Read and write presence information for all users", - "id": "83cded22-8297-4ff6-a7fa-e97e9545a259", - "origin": "Application", - "value": "Presence.ReadWrite.All" - }, - { - "description": "Allows the app to read and write tags in Teams without a signed-in user.", - "displayName": "Read and write tags in Teams", - "id": "a3371ca5-911d-46d6-901c-42c8c7a937d8", - "origin": "Application", - "value": "TeamworkTag.ReadWrite.All" - }, - { - "description": "Allows the app to read\u00a0tags in Teams\u00a0without a signed-in user.", - "displayName": "Read tags in Teams", - "id": "b74fd6c4-4bde-488e-9695-eeb100e4907f", - "origin": "Application", - "value": "TeamworkTag.Read.All" - }, - { - "description": "Allows the app to read and write all Windows update deployment settings for the organization without a signed-in user.", - "displayName": "Read and write all Windows update deployment settings", - "id": "7dd1be58-6e76-4401-bf8d-31d1e8180d5b", - "origin": "Application", - "value": "WindowsUpdates.ReadWrite.All" - }, - { - "description": "Allows the app to read and write external connections without a signed-in user. The app can only read and write external connections that it is authorized to, or it can create new external connections. ", - "displayName": "Read and write external connections", - "id": "f431331c-49a6-499f-be1c-62af19c34a9d", - "origin": "Application", - "value": "ExternalConnection.ReadWrite.OwnedBy" - }, - { - "description": "Allows the app to read and write external items without a signed-in user. The app can only read external items of the connection that it is authorized to.", - "displayName": "Read and write external items", - "id": "8116ae0f-55c2-452d-9944-d18420f5b2c8", - "origin": "Application", - "value": "ExternalItem.ReadWrite.OwnedBy" - }, - { - "description": "Allow the application to access a subset of site collections without a signed in user.\u00a0\u00a0The specific site collections and the permissions granted will be configured in SharePoint Online.", - "displayName": "Access selected site collections", - "id": "883ea226-0bf2-4a8f-9f9d-92c9162a727d", - "origin": "Application", - "value": "Sites.Selected" - }, - { - "description": "Allows the app to read documents and list items in all site collections without a signed in user.", - "displayName": "Read items in all site collections ", - "id": "332a536c-c7ef-4017-ab91-336970924f0d", - "origin": "Application", - "value": "Sites.Read.All" - }, - { - "description": "Allows the app to create, read, update, and delete documents and list items in all site collections without a signed in user.", - "displayName": "Read and write items in all site collections", - "id": "9492366f-7969-46a4-8d15-ed1a20078fff", - "origin": "Application", - "value": "Sites.ReadWrite.All" - }, - { - "description": "Allows the app to read and write the properties of Cloud PCs, without a signed-in user.", - "displayName": "Read and write Cloud PCs", - "id": "3b4349e1-8cf5-45a3-95b7-69d1751d3e6a", - "origin": "Application", - "value": "CloudPC.ReadWrite.All" - }, - { - "description": "Allows the app to read the properties of Cloud PCs, without a signed-in user.", - "displayName": "Read Cloud PCs", - "id": "a9e09520-8ed4-4cde-838e-4fdea192c227", - "origin": "Application", - "value": "CloudPC.Read.All" - }, - { - "description": "Allows the app to update service principal endpoints", - "displayName": "Read and update service principal endpoints", - "id": "89c8469c-83ad-45f7-8ff2-6e3d4285709e", - "origin": "Application", - "value": "ServicePrincipalEndpoint.ReadWrite.All" - }, - { - "description": "Allows the app to read service principal endpoints", - "displayName": "Read service principal endpoints", - "id": "5256681e-b7f6-40c0-8447-2d9db68797a0", - "origin": "Application", - "value": "ServicePrincipalEndpoint.Read.All" - }, - { - "description": "Allows the app to create new notifications in users' teamwork activity feeds without a signed in user. These notifications may not be discoverable or be held or governed by compliance policies.", - "displayName": "Send a teamwork activity to any user", - "id": "a267235f-af13-44dc-8385-c1dc93023186", - "origin": "Application", - "value": "TeamsActivity.Send" - }, - { - "description": "Allows the app to read terms of use acceptance statuses, without a signed in user.", - "displayName": "Read all terms of use acceptance statuses", - "id": "d8e4ec18-f6c0-4620-8122-c8b1f2bf400e", - "origin": "Application", - "value": "AgreementAcceptance.Read.All" - }, - { - "description": "Allows the app to read and write terms of use agreements, without a signed in user.", - "displayName": "Read and write all terms of use agreements", - "id": "c9090d00-6101-42f0-a729-c41074260d47", - "origin": "Application", - "value": "Agreement.ReadWrite.All" - }, - { - "description": "Allows the app to read terms of use agreements, without a signed in user.", - "displayName": "Read all terms of use agreements", - "id": "2f3e6f8c-093b-4c57-a58b-ba5ce494a169", - "origin": "Application", - "value": "Agreement.Read.All" - }, - { - "description": "Allows the app to read app consent requests and approvals, and deny or approve those requests without a signed-in user.", - "displayName": "Read and write all consent requests", - "id": "9f1b81a7-0223-4428-bfa4-0bcb5535f27d", - "origin": "Application", - "value": "ConsentRequest.ReadWrite.All" - }, - { - "description": "Allows the app to read and write your organization's consent requests policy without a signed-in user.", - "displayName": "Read and write your organization's consent request policy", - "id": "999f8c63-0a38-4f1b-91fd-ed1947bdd1a9", - "origin": "Application", - "value": "Policy.ReadWrite.ConsentRequest" - }, - { - "description": "Allows the app to read consent requests and approvals without a signed-in user.", - "displayName": "Read all consent requests", - "id": "1260ad83-98fb-4785-abbb-d6cc1806fd41", - "origin": "Application", - "value": "ConsentRequest.Read.All" - }, - { - "description": "Allows the app to read basic mail properties in all mailboxes without a signed-in user. Includes all properties except body, previewBody, attachments and any extended properties.", - "displayName": "Read basic mail in all mailboxes", - "id": "693c5e45-0940-467d-9b8a-1022fb9d42ef", - "origin": "Application", - "value": "Mail.ReadBasic.All" - }, - { - "description": "Allows the app to read basic mail properties in all mailboxes without a signed-in user. Includes all properties except body, previewBody, attachments and any extended properties.", - "displayName": "Read basic mail in all mailboxes", - "id": "6be147d2-ea4f-4b5a-a3fa-3eab6f3c140a", - "origin": "Application", - "value": "Mail.ReadBasic" - }, - { - "description": "Allows the app to read and write feature rollout policies without a signed-in user. Includes abilities to assign and remove users and groups to rollout of a specific feature.", - "displayName": "Read and write feature rollout policies", - "id": "2044e4f1-e56c-435b-925c-44cd8f6ba89a", - "origin": "Application", - "value": "Policy.ReadWrite.FeatureRollout" - }, - { - "description": "Allows the app to read and manage the role-based access control (RBAC) settings for your company's directory, without a signed-in user. This includes instantiating directory roles and managing directory role membership, and reading directory role templates, directory roles and memberships.", - "displayName": "Read and write all directory RBAC settings", - "id": "9e3f62cf-ca93-4989-b6ce-bf83c28f9fe8", - "origin": "Application", - "value": "RoleManagement.ReadWrite.Directory" - }, - { - "description": "Allows the app to read the role-based access control (RBAC) settings for your company's directory, without a signed-in user. This includes reading directory role templates, directory roles and memberships.", - "displayName": "Read all directory RBAC settings", - "id": "483bed4a-2ad3-4361-a73b-c83ccdbdc53c", - "origin": "Application", - "value": "RoleManagement.Read.Directory" - }, - { - "description": "Allows the app to read and write the organization and related resources, without a signed-in user.\u00a0Related resources include things like subscribed skus and tenant branding information.", - "displayName": "Read and write organization information", - "id": "292d869f-3427-49a8-9dab-8c70152b74e9", - "origin": "Application", - "value": "Organization.ReadWrite.All" - }, - { - "description": "Allows the app to read the organization and related resources, without a signed-in user.\u00a0Related resources include things like subscribed skus and tenant branding information.", - "displayName": "Read organization information", - "id": "498476ce-e0fe-48b0-b801-37ba7e2685c6", - "origin": "Application", - "value": "Organization.Read.All" - }, - { - "description": "Allows the app to read company places (conference rooms and room lists) for calendar events and other applications, without a signed-in user.", - "displayName": "Read all company places", - "id": "913b9306-0ce1-42b8-9137-6a7df690a760", - "origin": "Application", - "value": "Place.Read.All" - }, - { - "description": "Allows the app to read the memberships of hidden groups and administrative units without a signed-in user.", - "displayName": "Read all hidden memberships", - "id": "658aa5d8-239f-45c4-aa12-864f4fc7e490", - "origin": "Application", - "value": "Member.Read.Hidden" - }, - { - "description": "Allow the app to read or write items in all external datasets that the app is authorized to access", - "displayName": "Read and write items in external datasets", - "id": "38c3d6ee-69ee-422f-b954-e17819665354", - "origin": "Application", - "value": "ExternalItem.ReadWrite.All" - }, - { - "description": "Allows the app to read, update, delete and perform actions on access reviews, reviewers, decisions and settings in the organization for group and app memberships, without a signed-in user.", - "displayName": "Manage access reviews for group and app memberships", - "id": "18228521-a591-40f1-b215-5fad4488c117", - "origin": "Application", - "value": "AccessReview.ReadWrite.Membership" - }, - { - "description": "Allows the app to read properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups, without a signed-in user.", - "displayName": "Read Microsoft Intune device configuration and policies", - "id": "dc377aa6-52d8-4e23-b271-2a7ae04cedf3", - "origin": "Application", - "value": "DeviceManagementConfiguration.Read.All" - }, - { - "description": "Allows the app to read the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune, without a signed-in user.", - "displayName": "Read Microsoft Intune apps", - "id": "7a6ee1e7-141e-4cec-ae74-d9db155731ff", - "origin": "Application", - "value": "DeviceManagementApps.Read.All" - }, - { - "description": "Allows the app to read the properties of devices managed by Microsoft Intune, without a signed-in user.", - "displayName": "Read Microsoft Intune devices", - "id": "2f51be20-0bb4-4fed-bf7b-db946066c75e", - "origin": "Application", - "value": "DeviceManagementManagedDevices.Read.All" - }, - { - "description": "Allows the app to read the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings, without a signed-in user.", - "displayName": "Read Microsoft Intune RBAC settings", - "id": "58ca0d9a-1575-47e1-a3cb-007ef2e4583b", - "origin": "Application", - "value": "DeviceManagementRBAC.Read.All" - }, - { - "description": "Allows the app to read Microsoft Intune service properties including device enrollment and third party service connection configuration, without a signed-in user.", - "displayName": "Read Microsoft Intune configuration", - "id": "06a5fe6d-c49d-46a7-b082-56b1b14103c7", - "origin": "Application", - "value": "DeviceManagementServiceConfig.Read.All" - }, - { - "description": "Allows the app to create, view, update and delete on-premises published resources, on-premises agents and agent groups, as part of a hybrid identity configuration, without a signed in user.", - "displayName": "Manage on-premises published resources", - "id": "0b57845e-aa49-4e6f-8109-ce654fffa618", - "origin": "Application", - "value": "OnPremisesPublishingProfiles.ReadWrite.All" - }, - { - "description": "Allows the app to read and write trust framework key set properties without a signed-in user.", - "displayName": "Read and write trust framework key sets", - "id": "4a771c9a-1cf2-4609-b88e-3d3e02d539cd", - "origin": "Application", - "value": "TrustFrameworkKeySet.ReadWrite.All" - }, - { - "description": "Allows the app to read trust framework key set properties without a signed-in user.", - "displayName": "Read trust framework key sets", - "id": "fff194f1-7dce-4428-8301-1badb5518201", - "origin": "Application", - "value": "TrustFrameworkKeySet.Read.All" - }, - { - "description": "Allows the app to read and write your organization's trust framework policies without a signed in user.", - "displayName": "Read and write your organization's trust framework policies", - "id": "79a677f7-b79d-40d0-a36a-3e6f8688dd7a", - "origin": "Application", - "value": "Policy.ReadWrite.TrustFramework" - }, - { - "description": "Allows the app to read all your organization's policies without a signed in user.", - "displayName": "Read your organization's policies", - "id": "246dd0d5-5bd0-4def-940b-0421030a5b68", - "origin": "Application", - "value": "Policy.Read.All" - }, - { - "description": "Allows the app to read and write your organization\u2019s identity (authentication) providers\u2019 properties without a signed in user.", - "displayName": "Read and write identity providers", - "id": "90db2b9a-d928-4d33-a4dd-8442ae3d41e4", - "origin": "Application", - "value": "IdentityProvider.ReadWrite.All" - }, - { - "description": "Allows the app to read your organization\u2019s identity (authentication) providers\u2019 properties without a signed in user.", - "displayName": "Read identity providers", - "id": "e321f0bb-e7f7-481e-bb28-e3b0b32d4bd0", - "origin": "Application", - "value": "IdentityProvider.Read.All" - }, - { - "description": "Allows the app to create, read, update, and delete administrative units and manage administrative unit membership without a signed-in user.", - "displayName": "Read and write all administrative units", - "id": "5eb59dd3-1da2-4329-8733-9dabdc435916", - "origin": "Application", - "value": "AdministrativeUnit.ReadWrite.All" - }, - { - "description": "Allows the app to read administrative units and administrative unit membership without a signed-in user.", - "displayName": "Read all administrative units", - "id": "134fd756-38ce-4afd-ba33-e9623dbe66c2", - "origin": "Application", - "value": "AdministrativeUnit.Read.All" - }, - { - "description": "Allows an app to read published sensitivity labels and label policy settings for the entire organization or a specific user, without a signed in user.", - "displayName": "Read all published labels and label policies for an organization.", - "id": "19da66cb-0fb0-4390-b071-ebc76a349482", - "origin": "Application", - "value": "InformationProtectionPolicy.Read.All" - }, - { - "description": "Allows the app to read all the OneNote notebooks in your organization, without a signed-in user.", - "displayName": "Read all OneNote notebooks", - "id": "3aeca27b-ee3a-4c2b-8ded-80376e2134a4", - "origin": "Application", - "value": "Notes.Read.All" - }, - { - "description": "Allows the app to invite guest users to the organization, without a signed-in user.", - "displayName": "Invite guest users to the organization", - "id": "09850681-111b-4a89-9bed-3f2cae46d706", - "origin": "Application", - "value": "User.Invite.All" - }, - { - "description": "Allows the app to read, create, update and delete all files in all site collections without a signed in user. ", - "displayName": "Read and write files in all site collections", - "id": "75359482-378d-4052-8f01-80520e7db3cd", - "origin": "Application", - "value": "Files.ReadWrite.All" - }, - { - "description": "Allows the app to create threat indicators, and fully manage those threat indicators (read, update and delete), without a signed-in user. \u00a0It cannot update any threat indicators it does not own.", - "displayName": "Manage threat indicators this app creates or owns", - "id": "21792b6c-c986-4ffc-85de-df9da54b52fa", - "origin": "Application", - "value": "ThreatIndicators.ReadWrite.OwnedBy" - }, - { - "description": "Allows the app to read or update security actions, without a signed-in user.", - "displayName": "Read and update your organization's security actions", - "id": "f2bf083f-0179-402a-bedb-b2784de8a49b", - "origin": "Application", - "value": "SecurityActions.ReadWrite.All" - }, - { - "description": "Allows the app to read security actions, without a signed-in user.", - "displayName": "Read your organization's security actions", - "id": "5e0edab9-c148-49d0-b423-ac253e121825", - "origin": "Application", - "value": "SecurityActions.Read.All" - }, - { - "description": "Allows the app to read your organization\u2019s security events without a signed-in user. Also allows the app to update editable properties in security events.", - "displayName": "Read and update your organization\u2019s security events", - "id": "d903a879-88e0-4c09-b0c9-82f6a1333f84", - "origin": "Application", - "value": "SecurityEvents.ReadWrite.All" - }, - { - "description": "Allows the app to read your organization\u2019s security events without a signed-in user.", - "displayName": "Read your organization\u2019s security events", - "id": "bf394140-e372-4bf9-a898-299cfc7564e5", - "origin": "Application", - "value": "SecurityEvents.Read.All" - }, - { - "description": "Allows an app to read and write all chat messages in Microsoft Teams, without a signed-in user.", - "displayName": "Read and write all chat messages", - "id": "294ce7c9-31ba-490a-ad7d-97a7d075e4ed", - "origin": "Application", - "value": "Chat.ReadWrite.All" - }, - { - "description": "Allows the app to read and update identity risk detection information for your organization without a signed-in user. Update operations include confirming risk event detections.\u00a0", - "displayName": "Read and write all risk detection information", - "id": "db06fb33-1953-4b7b-a2ac-f1e2c854f7ae", - "origin": "Application", - "value": "IdentityRiskEvent.ReadWrite.All" - }, - { - "description": "Allows the app to read and update identity risky user information for your organization without a signed-in user. \u00a0Update operations include dismissing risky users.", - "displayName": "Read and write all risky user information", - "id": "656f6061-f9fe-4807-9708-6a2e0934df76", - "origin": "Application", - "value": "IdentityRiskyUser.ReadWrite.All" - }, - { - "description": "Allows the app to read all files in all site collections without a signed in user.", - "displayName": "Read files in all site collections", - "id": "01d4889c-1287-42c6-ac1f-5d1e02578ef6", - "origin": "Application", - "value": "Files.Read.All" - }, - { - "description": "Allows the app to read the identity risk event information for your organization without a signed in user.", - "displayName": "Read all identity risk event information", - "id": "6e472fd1-ad78-48da-a0f0-97ab2c6b769e", - "origin": "Application", - "value": "IdentityRiskEvent.Read.All" - }, - { - "description": "Allows the app to read a limited subset of properties from both the structure of schools and classes in the organization's roster and education-specific information about all users. Includes name, status, role, email address and photo.", - "displayName": "Read a limited subset of the organization's roster", - "id": "0d412a8c-a06c-439f-b3ec-8abcf54d2f96", - "origin": "Application", - "value": "EduRoster.ReadBasic.All" - }, - { - "description": "Allows the app to read the structure of schools and classes in the organization's roster and education-specific information about all users to be read.", - "displayName": "Read the organization's roster", - "id": "e0ac9e1b-cb65-4fc5-87c5-1a8bc181f648", - "origin": "Application", - "value": "EduRoster.Read.All" - }, - { - "description": "Allows the app to read and write the structure of schools and classes in the organization's roster and education-specific information about all users to be read and written.", - "displayName": "Read and write the organization's roster", - "id": "d1808e82-ce13-47af-ae0d-f9b254e6d58a", - "origin": "Application", - "value": "EduRoster.ReadWrite.All" - }, - { - "description": "Read the state and settings of all Microsoft education apps.", - "displayName": "Read Education app settings", - "id": "7c9db06a-ec2d-4e7b-a592-5a1e30992566", - "origin": "Application", - "value": "EduAdministration.Read.All" - }, - { - "description": "Manage the state and settings of all Microsoft education apps.", - "displayName": "Manage education app settings", - "id": "9bc431c3-b8bc-4a8d-a219-40f10f92eff6", - "origin": "Application", - "value": "EduAdministration.ReadWrite.All" - }, - { - "description": "Allows the app to read the identity risky user information for your organization without a signed in user.", - "displayName": "Read all identity risky user information", - "id": "dc5007c0-2d7d-4c42-879c-2dab87571379", - "origin": "Application", - "value": "IdentityRiskyUser.Read.All" - }, - { - "description": "Allows the app to read and update user profiles without a signed in user.", - "displayName": "Read and write all users' full profiles", - "id": "741f803b-c850-494e-b5df-cde7c675a1ca", - "origin": "Application", - "value": "User.ReadWrite.All" - }, - { - "description": "Allows the app to read user profiles without a signed in user.", - "displayName": "Read all users' full profiles", - "id": "df021288-bdef-4463-88db-98f22de89214", - "origin": "Application", - "value": "User.Read.All" - }, - { - "description": "Allows the app to read and query your audit log activities, without a signed-in user.", - "displayName": "Read all audit log data", - "id": "b0afded3-3588-46d8-8b3d-9842eff778da", - "origin": "Application", - "value": "AuditLog.Read.All" - }, - { - "description": "Allows the app to create other applications, and fully manage those applications (read, update, update application secrets and delete), without a signed-in user. \u00a0It cannot update any apps that it is not an owner of.", - "displayName": "Manage apps that this app creates or owns", - "id": "18a4783c-866b-4cc7-a460-3d5e5662c884", - "origin": "Application", - "value": "Application.ReadWrite.OwnedBy" - }, - { - "description": "Allows the app to export data (e.g. customer content or system-generated logs), associated with any user in your company, when the app is used by a privileged user (e.g. a Company Administrator).", - "displayName": "Export user's data", - "id": "405a51b5-8d8d-430b-9842-8be4b0e9f324", - "origin": "Application", - "value": "User.Export.All" - }, - { - "description": "Allows the app to read, update, delete and perform actions on programs and program controls in the organization, without a signed-in user.", - "displayName": "Manage all programs", - "id": "60a901ed-09f7-4aa5-a16e-7dd3d6f9de36", - "origin": "Application", - "value": "ProgramControl.ReadWrite.All" - }, - { - "description": "Allows the app to read programs and program controls in the organization, without a signed-in user.", - "displayName": "Read all programs", - "id": "eedb7fdd-7539-4345-a38b-4839e4a84cbd", - "origin": "Application", - "value": "ProgramControl.Read.All" - }, - { - "description": "Allows the app to read, update, delete and perform actions on access reviews, reviewers, decisions and settings in the organization, without a signed-in user.", - "displayName": "Manage all access reviews", - "id": "ef5f7d5c-338f-44b0-86c3-351f46c8bb5f", - "origin": "Application", - "value": "AccessReview.ReadWrite.All" - }, - { - "description": "Allows the app to read access reviews, reviewers, decisions and settings in the organization, without a signed-in user.", - "displayName": "Read all access reviews", - "id": "d07a8cc0-3d51-4b77-b3b0-32704d1f69fa", - "origin": "Application", - "value": "AccessReview.Read.All" - }, - { - "description": "Allows an app to read all service usage reports without a signed-in user. Services that provide usage reports include Office 365 and Azure Active Directory.", - "displayName": "Read all usage reports", - "id": "230c1aed-a721-4c5d-9cb4-a90514e508ef", - "origin": "Application", - "value": "Reports.Read.All" - }, - { - "description": "Allows the app to read any user's scored list of relevant people, without a signed-in user. The list can include local contacts, contacts from social networking, your organization's directory, and people from recent communications (such as email and Skype).", - "displayName": "Read all users' relevant people lists", - "id": "b528084d-ad10-4598-8b93-929746b4d7d6", - "origin": "Application", - "value": "People.Read.All" - }, - { - "description": "Allows the app to update Microsoft Teams 1-to-1 or group chat messages by patching a set of Data Loss Prevention (DLP) policy violation properties to handle the output of DLP processing.", - "displayName": "Flag chat messages for violating policy", - "id": "7e847308-e030-4183-9899-5235d7270f58", - "origin": "Application", - "value": "Chat.UpdatePolicyViolation.All" - }, - { - "description": "Allows the app to read all 1-to-1 or group chat messages in Microsoft Teams.", - "displayName": "Read all chat messages", - "id": "6b7d71aa-70aa-4810-a8d9-5d9fb2830017", - "origin": "Application", - "value": "Chat.Read.All" - }, - { - "description": "Allows the app to read all channel messages in Microsoft Teams", - "displayName": "Read all channel messages", - "id": "7b2449af-6ccd-4f4d-9f78-e550c193f0d1", - "origin": "Application", - "value": "ChannelMessage.Read.All" - }, - { - "description": "Allows the app to update Microsoft Teams channel messages by patching a set of Data Loss Prevention (DLP) policy violation properties to handle the output of DLP processing.", - "displayName": "Flag channel messages for violating policy", - "id": "4d02b0cc-d90b-441f-8d82-4fb55c34d6bb", - "origin": "Application", - "value": "ChannelMessage.UpdatePolicyViolation.All" - }, - { - "description": "Allows the app to create, read, update and delete applications and service principals without a signed-in user. Does not allow management of consent grants.", - "displayName": "Read and write all applications", - "id": "1bfefb4e-e0b5-418b-a88f-73c46d2cc8e9", - "origin": "Application", - "value": "Application.ReadWrite.All" - }, - { - "description": "Allows the app to create, read, update, and delete user's mailbox settings without a signed-in user. Does not include permission to send mail.", - "displayName": "Read and write all user mailbox settings", - "id": "6931bccd-447a-43d1-b442-00a195474933", - "origin": "Application", - "value": "MailboxSettings.ReadWrite" - }, - { - "description": "Allows the app to read and write all domain properties without a signed in user. \u00a0Also allows the app to add, \u00a0verify and remove domains.", - "displayName": "Read and write domains", - "id": "7e05723c-0bb0-42da-be95-ae9f08a6e53c", - "origin": "Application", - "value": "Domain.ReadWrite.All" - }, - { - "description": "Allows the app to read user's mailbox settings without a signed-in user. Does not include permission to send mail.", - "displayName": "Read all user mailbox settings", - "id": "40f97065-369a-49f4-947c-6a255697ae91", - "origin": "Application", - "value": "MailboxSettings.Read" - }, - { - "description": "Allows the app to read mail in all mailboxes without a signed-in user.", - "displayName": "Read mail in all mailboxes", - "id": "810c84a8-4a9e-49e6-bf7d-12d183f40d01", - "origin": "Application", - "value": "Mail.Read" - }, - { - "description": "Allows the app to create, read, update, and delete mail in all mailboxes without a signed-in user. Does not include permission to send mail.", - "displayName": "Read and write mail in all mailboxes", - "id": "e2a3a72e-5f79-4c64-b1b1-878b674786c9", - "origin": "Application", - "value": "Mail.ReadWrite" - }, - { - "description": "Allows the app to send mail as any user without a signed-in user.", - "displayName": "Send mail as any user", - "id": "b633e1c5-b582-4048-a93e-9f11b44c7e96", - "origin": "Application", - "value": "Mail.Send" - }, - { - "description": "Allows the app to read all contacts in all mailboxes without a signed-in user.", - "displayName": "Read contacts in all mailboxes", - "id": "089fe4d0-434a-44c5-8827-41ba8a0b17f5", - "origin": "Application", - "value": "Contacts.Read" - }, - { - "description": "Allows the app to create, read, update, and delete all contacts in all mailboxes without a signed-in user.", - "displayName": "Read and write contacts in all mailboxes", - "id": "6918b873-d17a-4dc1-b314-35f528134491", - "origin": "Application", - "value": "Contacts.ReadWrite" - }, - { - "description": "Allows the app to read data in your organization's directory, such as users, groups and apps, without a signed-in user.", - "displayName": "Read directory data", - "id": "7ab1d382-f21e-4acd-a863-ba3e13f7da61", - "origin": "Application", - "value": "Directory.Read.All" - }, - { - "description": "Allows the app to read and write data in your organization's directory, such as users, and groups, without a signed-in user. Does not allow user or group deletion.", - "displayName": "Read and write directory data", - "id": "19dbc75e-c2e2-444c-a770-ec69d8559fc7", - "origin": "Application", - "value": "Directory.ReadWrite.All" - }, - { - "description": "Allows the app to read and write all device properties without a signed in user. Does not allow device creation, device deletion or update of device alternative security identifiers.", - "displayName": "Read and write devices", - "id": "1138cb37-bd11-4084-a2b7-9f71582aeddb", - "origin": "Application", - "value": "Device.ReadWrite.All" - }, - { - "description": "Allows the app to read events of all calendars without a signed-in user.", - "displayName": "Read calendars in all mailboxes", - "id": "798ee544-9d2d-430c-a058-570e29e34338", - "origin": "Application", - "value": "Calendars.Read" - }, - { - "description": "Allows the app to create, read, update, and delete events of all calendars without a signed-in user.", - "displayName": "Read and write calendars in all mailboxes", - "id": "ef54d2bf-783f-4e0f-bca1-3210c0444d99", - "origin": "Application (Office 365 Exchange Online)", - "value": "Calendars.ReadWrite.All" - }, - { - "description": "Allows the app to create, read, update, and delete user's mailbox settings without a signed-in user. Does not include permission to send mail.", - "displayName": "Read and write all user mailbox settings", - "id": "f9156939-25cd-4ba8-abfe-7fabcf003749", - "origin": "Application (Office 365 Exchange Online)", - "value": "Mailbox.Settings.ReadWrite" - }, - { - "description": "Allows the app to read your organization's user flows, without a signed-in user.", - "displayName": "Read all identity user flows", - "id": "1b0c317f-dd31-4305-9932-259a8b6e8099", - "origin": "Application", - "value": "IdentityUserFlow.Read.All" - }, - { - "description": "Allows the app to read or write your organization's user flows, without a signed-in user.", - "displayName": "Read and write all identity user flows", - "id": "65319a09-a2be-469d-8782-f6b07debf789", - "origin": "Application", - "value": "IdentityUserFlow.ReadWrite.All" - }, - { - "description": "Allows the app to read and create online meetings as an application in your organization.", - "displayName": "Read and create online meetings", - "id": "b8bb2037-6e08-44ac-a4ea-4674e010e2a4", - "origin": "Application", - "value": "OnlineMeetings.ReadWrite.All" - }, - { - "description": "Allows the app to read online meeting details in your organization, without a signed-in user.", - "displayName": "Read online meeting details", - "id": "c1684f21-1984-47fa-9d61-2dc8c296bb70", - "origin": "Application", - "value": "OnlineMeetings.Read.All" - }, - { - "description": "Allows the app to get direct access to media streams in a call, without a signed-in user.", - "displayName": "Access media streams in a call as an app", - "id": "a7a681dc-756e-4909-b988-f160edc6655f", - "origin": "Application", - "value": "Calls.AccessMedia.All" - }, - { - "description": "Allows the app to anonymously join group calls and scheduled meetings in your organization, without a signed-in user. \u00a0The app will be joined as a guest to meetings in your organization.", - "displayName": "Join group calls and meetings as a guest", - "id": "fd7ccf6b-3d28-418b-9701-cd10f5cd2fd4", - "origin": "Application", - "value": "Calls.JoinGroupCallAsGuest.All" - }, - { - "description": "Allows the app to join group calls and scheduled meetings in your organization, without a signed-in user. \u00a0The app will be joined with the privileges of a directory user to meetings in your organization.", - "displayName": "Join group calls and meetings as an app", - "id": "f6b49018-60ab-4f81-83bd-22caeabfed2d", - "origin": "Application", - "value": "Calls.JoinGroupCall.All" - }, - { - "description": "Allows the app to place outbound calls to multiple users and add participants to meetings in your organization, without a signed-in user.", - "displayName": "Initiate outgoing group calls from the app", - "id": "4c277553-8a09-487b-8023-29ee378d8324", - "origin": "Application", - "value": "Calls.InitiateGroupCall.All" - }, - { - "description": "Allows the app to place outbound calls to a single user and transfer calls to users in your organization\u2019s directory, without a signed-in user.", - "displayName": "Initiate outgoing 1 to 1 calls from the app", - "id": "284383ee-7f6e-4e40-a2a8-e85dcb029101", - "origin": "Application", - "value": "Calls.Initiate.All" - }, - { - "description": "Allows the app to read all organizational contacts without a signed-in user. These contacts are managed by the organization and are different from a user's personal contacts.", - "displayName": "Read organizational contacts", - "id": "e1a88a34-94c4-4418-be12-c87b00e26bea", - "origin": "Application", - "value": "OrgContact.Read.All" - }, - { - "description": "Allows the app to read and write the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune, without a signed-in user.", - "displayName": "Read and write Microsoft Intune apps", - "id": "78145de6-330d-4800-a6ce-494ff2d33d07", - "origin": "Application", - "value": "DeviceManagementApps.ReadWrite.All" - }, - { - "description": "Allows the app to read and write properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups, without a signed-in user.", - "displayName": "Read and write Microsoft Intune device configuration and policies", - "id": "9241abd9-d0e6-425a-bd4f-47ba86e767a4", - "origin": "Application", - "value": "DeviceManagementConfiguration.ReadWrite.All" - }, - { - "description": "Allows the app to perform remote high impact actions such as wiping the device or resetting the passcode on devices managed by Microsoft Intune, without a signed-in user.", - "displayName": "Perform user-impacting remote actions on Microsoft Intune devices", - "id": "5b07b0dd-2377-4e44-a38d-703f09a0dc3c", - "origin": "Application", - "value": "DeviceManagementManagedDevices.PrivilegedOperations.All" - }, - { - "description": "Allows the app to read and write the properties of devices managed by Microsoft Intune, without a signed-in user. Does not allow high impact operations such as remote wipe and password reset on the device\u2019s owner", - "displayName": "Read and write Microsoft Intune devices", - "id": "243333ab-4d21-40cb-a475-36241daa0842", - "origin": "Application", - "value": "DeviceManagementManagedDevices.ReadWrite.All" - }, - { - "description": "Allows the app to read and write the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings, without a signed-in user.", - "displayName": "Read and write Microsoft Intune RBAC settings", - "id": "e330c4f0-4170-414e-a55a-2f022ec2b57b", - "origin": "Application", - "value": "DeviceManagementRBAC.ReadWrite.All" - }, - { - "description": "Allows the app to read and write Microsoft Intune service properties including device enrollment and third party service connection configuration, without a signed-in user.", - "displayName": "Read and write Microsoft Intune configuration", - "id": "5ac13192-7ace-4fcf-b828-1a26f28068ee", - "origin": "Application", - "value": "DeviceManagementServiceConfig.ReadWrite.All" - }, - { - "description": "Allows the app to manage permission grants for application permissions to any API (including Microsoft Graph) and application assignments for any app, without a signed-in user.", - "displayName": "Manage app permission grants and app role assignments", - "id": "06b708a9-e830-4db3-a914-8e69da51d44f", - "origin": "Application", - "value": "AppRoleAssignment.ReadWrite.All" - }, - { - "description": "Allows the app to manage permission grants for delegated permissions exposed by any API (including Microsoft Graph), without a signed-in user.", - "displayName": "Manage all delegated permission grants", - "id": "8e8e4742-1d95-4f68-9d56-6ee75648c72a", - "origin": "Application", - "value": "DelegatedPermissionGrant.ReadWrite.All" - }, - { - "description": "Allows the app to read all users' teamwork activity feed, without a signed-in user.", - "displayName": "Read all users' teamwork activity feed", - "id": "70dec828-f620-4914-aa83-a29117306807", - "origin": "Application", - "value": "TeamsActivity.Read.All" - }, - { - "description": "Allows the app to read time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD built-in and custom administrative roles in your organization, without a signed-in user.", - "displayName": "Read privileged access to Azure AD roles", - "id": "4cdc2547-9148-4295-8d11-be0db1391d6b", - "origin": "Application", - "value": "PrivilegedAccess.Read.AzureAD" - }, - { - "description": "Allows the app to read time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD groups in your organization, without a signed-in user.", - "displayName": "Read privileged access to Azure AD groups", - "id": "01e37dc9-c035-40bd-b438-b2879c4870a6", - "origin": "Application", - "value": "PrivilegedAccess.Read.AzureADGroup" - }, - { - "description": "Allows the app to read time-based assignment and just-in-time elevation of user privileges to audit Azure resources in your organization, without a signed-in user.", - "displayName": "Read privileged access to Azure resources", - "id": "5df6fe86-1be0-44eb-b916-7bd443a71236", - "origin": "Application", - "value": "PrivilegedAccess.Read.AzureResources" - }, - { - "description": "Allows the app to request and manage time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD built-in and custom administrative roles in your organization, without a signed-in user.", - "displayName": "Read and write privileged access to Azure AD roles", - "id": "854d9ab1-6657-4ec8-be45-823027bcd009", - "origin": "Application", - "value": "PrivilegedAccess.ReadWrite.AzureAD" - }, - { - "description": "Allows the app to request and manage time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD groups in your organization, without a signed-in user.", - "displayName": "Read and write privileged access to Azure AD groups", - "id": "2f6817f8-7b12-4f0f-bc18-eeaf60705a9e", - "origin": "Application", - "value": "PrivilegedAccess.ReadWrite.AzureADGroup" - }, - { - "description": "Allows the app to request and manage time-based assignment and just-in-time elevation of Azure resources (like your subscriptions, resource groups, storage, compute) in your organization, without a signed-in user.", - "displayName": "Read and write privileged access to Azure resources", - "id": "6f9d5abc-2db6-400b-a267-7de22a40fb87", - "origin": "Application", - "value": "PrivilegedAccess.ReadWrite.AzureResources" - }, - { - "description": "Allows the app to read all the indicators for your organization, without a signed-in user.", - "displayName": "Read all threat indicators", - "id": "197ee4e9-b993-4066-898f-d6aecc55125b", - "origin": "Application", - "value": "ThreatIndicators.Read.All" - }, - { - "description": "Allows the app to send, read, update and delete user\u2019s notifications, without a signed-in user.", - "displayName": "Deliver and manage all user's notifications", - "id": "4e774092-a092-48d1-90bd-baad67c7eb47", - "origin": "Application", - "value": "UserNotification.ReadWrite.CreatedByApp" - }, - { - "description": "Allows the app to read all applications and service principals without a signed-in user.", - "displayName": "Read all applications", - "id": "9a5d68dd-52b0-4cc2-bd40-abcf44ac3a30", - "origin": "Application", - "value": "Application.Read.All" - }, - { - "description": "Allows the app to read memberships and basic group properties for all groups without a signed-in user.", - "displayName": "Read all group memberships", - "id": "98830695-27a2-44f7-8c18-0c3ebc9698f6", - "origin": "Application", - "value": "GroupMember.Read.All" - }, - { - "description": "Allows the app to list groups, read basic properties, read and update the membership of the groups this app has access to without a signed-in user. Group properties and owners cannot be updated and groups cannot be deleted.", - "displayName": "Read and write all group memberships", - "id": "dbaae8cf-10b5-4b86-a4a1-f871c94c6695", - "origin": "Application", - "value": "GroupMember.ReadWrite.All" - }, - { - "description": "Allows the app to create groups without a signed-in user.", - "displayName": "Create groups", - "id": "bf7b1a76-6e77-406b-b258-bf5c7720e98f", - "origin": "Application", - "value": "Group.Create" - }, - { - "description": "Allows an app to read your organization's threat assessment requests, without a signed-in user.", - "displayName": "Read threat assessment requests", - "id": "f8f035bb-2cce-47fb-8bf5-7baf3ecbee48", - "origin": "Application", - "value": "ThreatAssessment.Read.All" - }, - { - "description": "Allows the app to read all schedules, schedule groups, shifts and associated entities in the Teams or Shifts application without a signed-in user.", - "displayName": "Read all schedule items", - "id": "7b2ebf90-d836-437f-b90d-7b62722c4456", - "origin": "Application", - "value": "Schedule.Read.All" - }, - { - "description": "Allows the app to manage all schedules, schedule groups, shifts and associated entities in the Teams or Shifts application without a signed-in user.", - "displayName": "Read and write all schedule items", - "id": "b7760610-0545-4e8a-9ec3-cce9e63db01c", - "origin": "Application", - "value": "Schedule.ReadWrite.All" - }, - { - "description": "Allows the app to read call records for all calls and online meetings without a signed-in user.", - "displayName": "Read all call records", - "id": "45bbb07e-7321-4fd7-a8f6-3ff27e6a81c8", - "origin": "Application", - "value": "CallRecords.Read.All" - }, - { - "description": "Allows the app to read and write your organization's conditional access policies, without a signed-in user.", - "displayName": "Read and write your organization's conditional access policies", - "id": "01c0a623-fc9b-48e9-b794-0756f8e8f067", - "origin": "Application", - "value": "Policy.ReadWrite.ConditionalAccess" - }, - { - "description": "Allows the application to read and write authentication methods of all users in your organization, without a signed-in user. Authentication methods include things like a user\u2019s phone numbers and Authenticator app settings. This does not allow the app to see secret information like passwords, or to sign-in or otherwise use the authentication methods", - "displayName": "Read and write all users' authentication methods ", - "id": "50483e42-d915-4231-9639-7fdb7fd190e5", - "origin": "Application", - "value": "UserAuthenticationMethod.ReadWrite.All" - }, - { - "description": " Allows the app to read authentication methods of all users in your organization, without a signed-in user. Authentication methods include things like a user\u2019s phone numbers and Authenticator app settings. This does not allow the app to see secret information like passwords, or to sign-in or otherwise use the authentication methods.", - "displayName": " Read all users' authentication methods", - "id": "38d9df27-64da-44fd-b7c5-a6fbac20248f", - "origin": "Application", - "value": "UserAuthenticationMethod.Read.All" - }, - { - "description": "Allows the app to create tabs in any team in Microsoft Teams, without a signed-in user. This does not grant the ability to read, modify or delete tabs after they are created, or give access to the content inside the tabs.", - "displayName": "Create tabs in Microsoft Teams.", - "id": "49981c42-fd7b-4530-be03-e77b21aed25e", - "origin": "Application", - "value": "TeamsTab.Create" - }, - { - "description": "Read the names and settings of tabs inside any team in Microsoft Teams, without a signed-in user. This does not give access to the content inside the tabs. ", - "displayName": "Read tabs in Microsoft Teams.", - "id": "46890524-499a-4bb2-ad64-1476b4f3e1cf", - "origin": "Application", - "value": "TeamsTab.Read.All" - }, - { - "description": "Read and write tabs in any team in Microsoft Teams, without a signed-in user. This does not give access to the content inside the tabs.", - "displayName": "Read and write tabs in Microsoft Teams.", - "id": "a96d855f-016b-47d7-b51c-1218a98d791c", - "origin": "Application", - "value": "TeamsTab.ReadWrite.All" - }, - { - "description": "Allows the app to read all domain properties without a signed-in user.", - "displayName": "Read domains", - "id": "dbb9058a-0e50-45d7-ae91-66909b5d4664", - "origin": "Application", - "value": "Domain.Read.All" - }, - { - "description": "Allows the app to read and write your organization's application configuration policies, without a signed-in user. This includes policies such as activityBasedTimeoutPolicy, claimsMappingPolicy, homeRealmDiscoveryPolicy, tokenIssuancePolicy and tokenLifetimePolicy.", - "displayName": "Read and write your organization's application configuration policies", - "id": "be74164b-cff1-491c-8741-e671cb536e13", - "origin": "Application", - "value": "Policy.ReadWrite.ApplicationConfiguration" - }, - { - "description": "Allows the app to read your organization's devices' configuration information without a signed-in user.", - "displayName": "Read all devices", - "id": "7438b122-aefc-4978-80ed-43db9fcc7715", - "origin": "Application", - "value": "Device.Read.All" - }, - { - "description": "Allows the app to read, update and delete identities that are associated with a user's account, without a signed in user. This controls the identities users can sign-in with.", - "displayName": "Manage all users' identities", - "id": "c529cfca-c91b-489c-af2b-d92990b66ce6", - "origin": "Application", - "value": "User.ManageIdentities.All" - }, - { - "description": "Allows the app to read all users' shift schedule preferences without a signed-in user.", - "displayName": "Read all user shift preferences", - "id": "de023814-96df-4f53-9376-1e2891ef5a18", - "origin": "Application", - "value": "UserShiftPreferences.Read.All" - }, - { - "description": "Allows the app to manage all users' shift schedule preferences without a signed-in user.", - "displayName": "Read and write all user shift preferences", - "id": "d1eec298-80f3-49b0-9efb-d90e224798ac", - "origin": "Application", - "value": "UserShiftPreferences.ReadWrite.All" - }, - { - "description": "Allows the app to read all the OneNote notebooks in your organization, without a signed-in user.", - "displayName": "Read and write all OneNote notebooks", - "id": "0c458cef-11f3-48c2-a568-c66751c238c0", - "origin": "Application", - "value": "Notes.ReadWrite.All" - }, - { - "description": "Allows the app to have full control of all site collections without a signed in user.", - "displayName": "Have full control of all site collections", - "id": "a82116e5-55eb-4c41-a434-62fe8a61c773", - "origin": "Application", - "value": "Sites.FullControl.All" - }, - { - "description": "Allows the app to create or delete document libraries and lists in all site collections without a signed in user.", - "displayName": "Create, edit, and delete items and lists in all site collections", - "id": "0c0bf378-bf22-4481-8f81-9e89a9b4960a", - "origin": "Application", - "value": "Sites.Manage.All" - }, - { - "description": "Allows the app to read access packages and related entitlement management resources without a signed-in user.", - "displayName": "Read all entitlement management resources", - "id": "c74fd47d-ed3c-45c3-9a9e-b8676de685d2", - "origin": "Application", - "value": "EntitlementManagement.Read.All" - }, - { - "description": "Allows the app to read and write access packages and related entitlement management resources without a signed-in user.", - "displayName": "Read and write all entitlement management resources", - "id": "9acd699f-1e81-4958-b001-93b1d2506e19", - "origin": "Application", - "value": "EntitlementManagement.ReadWrite.All" - }, - { - "description": "Create channels in any team, without a signed-in user.", - "displayName": "Create channels", - "id": "f3a65bd4-b703-46df-8f7e-0174fea562aa", - "origin": "Application", - "value": "Channel.Create" - }, - { - "description": "Delete channels in any team, without a signed-in user.", - "displayName": "Delete channels", - "id": "6a118a39-1227-45d4-af0c-ea7b40d210bc", - "origin": "Application", - "value": "Channel.Delete.All" - }, - { - "description": "Read all channel names, channel descriptions, and channel settings, without a signed-in user.", - "displayName": "Read the names, descriptions, and settings of all channels", - "id": "c97b873f-f59f-49aa-8a0e-52b32d762124", - "origin": "Application", - "value": "ChannelSettings.Read.All" - }, - { - "description": "Read and write the names, descriptions, and settings of all channels, without a signed-in user.", - "displayName": "Read and write the names, descriptions, and settings of all channels", - "id": "243cded2-bd16-4fd6-a953-ff8177894c3d", - "origin": "Application", - "value": "ChannelSettings.ReadWrite.All" - }, - { - "description": "Get a list of all teams, without a signed-in user.", - "displayName": "Get a list of all teams", - "id": "2280dda6-0bfd-44ee-a2f4-cb867cfc4c1e", - "origin": "Application", - "value": "Team.ReadBasic.All" - }, - { - "description": "Read all channel names and channel descriptions, without a signed-in user.", - "displayName": "Read the names and descriptions of all channels", - "id": "59a6b24b-4225-4393-8165-ebaec5f55d7a", - "origin": "Application", - "value": "Channel.ReadBasic.All" - }, - { - "description": "Read and change all teams' settings, without a signed-in user.", - "displayName": "Read and change all teams' settings", - "id": "bdd80a03-d9bc-451d-b7c4-ce7c63fe3c8f", - "origin": "Application", - "value": "TeamSettings.ReadWrite.All" - }, - { - "description": "Read all team's settings, without a signed-in user.", - "displayName": "Read all teams' settings", - "id": "242607bd-1d2c-432c-82eb-bdb27baa23ab", - "origin": "Application", - "value": "TeamSettings.Read.All" - }, - { - "description": "Read the members of all teams, without a signed-in user.", - "displayName": "Read the members of all teams", - "id": "660b7406-55f1-41ca-a0ed-0b035e182f3e", - "origin": "Application", - "value": "TeamMember.Read.All" - }, - { - "description": "Add and remove members from all teams, without a signed-in user. Also allows changing a team member's role, for example from owner to non-owner.", - "displayName": "Add and remove members from all teams", - "id": "0121dc95-1b9f-4aed-8bac-58c5ac466691", - "origin": "Application", - "value": "TeamMember.ReadWrite.All" - }, - { - "description": "Read the members of all channels, without a signed-in user.", - "displayName": "Read the members of all channels", - "id": "3b55498e-47ec-484f-8136-9013221c06a9", - "origin": "Application", - "value": "ChannelMember.Read.All" - }, - { - "description": "Add and remove members from all channels, without a signed-in user. Also allows changing a member's role, for example from owner to non-owner.", - "displayName": "Add and remove members from all channels", - "id": "35930dcf-aceb-4bd1-b99a-8ffed403c974", - "origin": "Application", - "value": "ChannelMember.ReadWrite.All" - }, - { - "description": "Allows the app to read and write all authentication flow policies for the tenant, without a signed-in user.", - "displayName": "Read and write authentication flow policies", - "id": "25f85f3c-f66c-4205-8cd5-de92dd7f0cec", - "origin": "Application", - "value": "Policy.ReadWrite.AuthenticationFlows" - }, - { - "description": "Allows the app to read and write all authentication method policies for the tenant, without a signed-in user.\u00a0", - "displayName": "Read and write all authentication method policies\u00a0", - "id": "29c18626-4985-4dcd-85c0-193eef327366", - "origin": "Application", - "value": "Policy.ReadWrite.AuthenticationMethod" - }, - { - "description": "Allows the app to read and write your organization's authorization policy without a signed in user. For example, authorization policies can control some of the permissions that the out-of-the-box user role has by default.", - "displayName": "Read and write your organization's authorization policy", - "id": "fb221be6-99f2-473f-bd32-01c6a0e9ca3b", - "origin": "Application", - "value": "Policy.ReadWrite.Authorization" - }, - { - "description": "Read names and members of all one-to-one and group chats in Microsoft Teams, without a signed-in user.", - "displayName": "Read names and members of all chat threads", - "id": "b2e060da-3baf-4687-9611-f4ebc0f0cbde", - "origin": "Application", - "value": "Chat.ReadBasic.All" - }, - { - "description": "Allows the app to read policies related to consent and permission grants for applications, without a signed-in user.", - "displayName": "Read consent and permission grant policies", - "id": "9e640839-a198-48fb-8b9a-013fd6f6cbcd", - "origin": "Application", - "value": "Policy.Read.PermissionGrant" - }, - { - "description": "Allows the app to manage policies related to consent and permission grants for applications, without a signed-in user.", - "displayName": "Manage consent and permission grant policies", - "id": "a402ca1c-2696-4531-972d-6e5ee4aa11ea", - "origin": "Application", - "value": "Policy.ReadWrite.PermissionGrant" - }, - { - "description": "Allows the application to read printers without a signed-in user.\u00a0", - "displayName": "Read printers", - "id": "9709bb33-4549-49d4-8ed9-a8f65e45bb0f", - "origin": "Application", - "value": "Printer.Read.All" - }, - { - "description": "Allows the application to read and update printers without a signed-in user. Does not allow creating (registering) or deleting (unregistering) printers.", - "displayName": "Read and update printers", - "id": "f5b3f73d-6247-44df-a74c-866173fddab0", - "origin": "Application", - "value": "Printer.ReadWrite.All" - }, - { - "description": "Allows the application to perform advanced operations like redirecting a print job to another printer without a signed-in user. Also allows the application to read and update the metadata of print jobs.", - "displayName": "Perform advanced operations on print jobs", - "id": "58a52f47-9e36-4b17-9ebe-ce4ef7f3e6c8", - "origin": "Application", - "value": "PrintJob.Manage.All" - }, - { - "description": "Allows the application to read the metadata and document content of print jobs without a signed-in user.\u00a0", - "displayName": "Read print jobs", - "id": "ac6f956c-edea-44e4-bd06-64b1b4b9aec9", - "origin": "Application", - "value": "PrintJob.Read.All" - }, - { - "description": "Allows the application to read the metadata of print jobs without a signed-in user.\u00a0Does not allow access to print job document content.", - "displayName": "Read basic information for print jobs", - "id": "fbf67eee-e074-4ef7-b965-ab5ce1c1f689", - "origin": "Application", - "value": "PrintJob.ReadBasic.All" - }, - { - "description": "Allows the application to read and update the metadata and document content of print jobs without a signed-in user.", - "displayName": "Read and write print jobs", - "id": "5114b07b-2898-4de7-a541-53b0004e2e13", - "origin": "Application", - "value": "PrintJob.ReadWrite.All" - }, - { - "description": "Allows the application to read and update the metadata of print jobs without a signed-in user.\u00a0Does not allow access to print job document content.", - "displayName": "Read and write basic information for print jobs", - "id": "57878358-37f4-4d3a-8c20-4816e0d457b1", - "origin": "Application", - "value": "PrintJob.ReadWriteBasic.All" - }, - { - "description": "Allows the application to read and update print task definitions without a signed-in user.\u00a0", - "displayName": "Read, write and update print task definitions", - "id": "456b71a7-0ee0-4588-9842-c123fcc8f664", - "origin": "Application", - "value": "PrintTaskDefinition.ReadWrite.All" - }, - { - "description": "Allows the app to create chat and channel messages, without a signed in user. The app specifies which user appears as the sender, and can backdate the message to appear as if it was sent long ago. The messages can be sent to any chat or channel in the organization.", - "displayName": "Create chat and channel messages with anyone's identity and with any timestamp", - "id": "dfb0dd15-61de-45b2-be36-d6a69fba3c79", - "origin": "Application", - "value": "Teamwork.Migrate.All" - }, - { - "description": "Allows the app to read the Teams apps that are installed in any chat, without a signed-in user. Does not give the ability to read application-specific settings.", - "displayName": "Read installed Teams apps for all chats", - "id": "cc7e7635-2586-41d6-adaa-a8d3bcad5ee5", - "origin": "Application", - "value": "TeamsAppInstallation.ReadForChat.All" - }, - { - "description": "Allows the app to read the Teams apps that are installed in any team, without a signed-in user. Does not give the ability to read application-specific settings.", - "displayName": "Read installed Teams apps for all teams", - "id": "1f615aea-6bf9-4b05-84bd-46388e138537", - "origin": "Application", - "value": "TeamsAppInstallation.ReadForTeam.All" - }, - { - "description": "Allows the app to read the Teams apps that are installed for any user, without a signed-in user. Does not give the ability to read application-specific settings.", - "displayName": "Read installed Teams apps for all users", - "id": "9ce09611-f4f7-4abd-a629-a05450422a97", - "origin": "Application", - "value": "TeamsAppInstallation.ReadForUser.All" - }, - { - "description": "Allows the app to read, install, upgrade, and uninstall Teams apps in any chat, without a signed-in user. Does not give the ability to read application-specific settings.", - "displayName": "Manage Teams apps for all chats", - "id": "9e19bae1-2623-4c4f-ab6e-2664615ff9a0", - "origin": "Application", - "value": "TeamsAppInstallation.ReadWriteForChat.All" - }, - { - "description": "Allows the app to read, install, upgrade, and uninstall Teams apps in any team, without a signed-in user. Does not give the ability to read application-specific settings.", - "displayName": "Manage Teams apps for all teams", - "id": "5dad17ba-f6cc-4954-a5a2-a0dcc95154f0", - "origin": "Application", - "value": "TeamsAppInstallation.ReadWriteForTeam.All" - }, - { - "description": "Allows the app to read, install, upgrade, and uninstall Teams apps for any user, without a signed-in user. Does not give the ability to read application-specific settings.", - "displayName": "Manage Teams apps for all users", - "id": "74ef0291-ca83-4d02-8c7e-d2391e6a444f", - "origin": "Application", - "value": "TeamsAppInstallation.ReadWriteForUser.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall itself for any chat, without a signed-in user.", - "displayName": "Allow the Teams app to manage itself for all chats", - "id": "73a45059-f39c-4baf-9182-4954ac0e55cf", - "origin": "Application", - "value": "TeamsAppInstallation.ReadWriteSelfForChat.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall itself in any team, without a signed-in user.", - "displayName": "Allow the Teams app to manage itself for all teams", - "id": "9f67436c-5415-4e7f-8ac1-3014a7132630", - "origin": "Application", - "value": "TeamsAppInstallation.ReadWriteSelfForTeam.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall itself to any user, without a signed-in user.", - "displayName": "Allow the app to manage itself for all users", - "id": "908de74d-f8b2-4d6b-a9ed-2a17b3b78179", - "origin": "Application", - "value": "TeamsAppInstallation.ReadWriteSelfForUser.All" - }, - { - "description": "Allows the app to create teams without a signed-in user.\u00a0", - "displayName": "Create teams", - "id": "23fc2474-f741-46ce-8465-674744c5c361", - "origin": "Application", - "value": "Team.Create" - }, - { - "description": "Add and remove members from all teams, without a signed-in user. Does not allow adding or removing a member with the owner role. Additionally, does not allow the app to elevate an existing member to the owner role.", - "displayName": "Add and remove members with non-owner role for all teams", - "id": "4437522e-9a86-4a41-a7da-e380edd4a97d", - "origin": "Application", - "value": "TeamMember.ReadWriteNonOwnerRole.All" - }, - { - "description": "Allows the app to read all term store data, without a signed-in user. This includes all sets, groups and terms in the term store.", - "displayName": "Read all term store data", - "id": "ea047cc2-df29-4f3e-83a3-205de61501ca", - "origin": "Application", - "value": "TermStore.Read.All" - }, - { - "description": "Allows the app to read, edit or write all term store data, without a signed-in user. This includes all sets, groups and terms in the term store.", - "displayName": "Read and write all term store data", - "id": "f12eb8d6-28e3-46e6-b2c0-b7e4dc69fc95", - "origin": "Application", - "value": "TermStore.ReadWrite.All" - }, - { - "description": "Allows the app to read your tenant's service health information, without a signed-in user. Health information may include service issues or service health overviews.", - "displayName": "Read service health", - "id": "79c261e0-fe76-4144-aad5-bdc68fbe4037", - "origin": "Application", - "value": "ServiceHealth.Read.All" - }, - { - "description": "Allows the app to read your tenant's service announcement messages, without a signed-in user. Messages may include information about new or changed features.", - "displayName": "Read service messages", - "id": "1b620472-6534-4fe6-9df2-4680e8aa28ec", - "origin": "Application", - "value": "ServiceMessage.Read.All" - }, - { - "description": "Allows the app to read all the short notes without a signed-in user.", - "displayName": "Read all users' short notes", - "id": "0c7d31ec-31ca-4f58-b6ec-9950b6b0de69", - "origin": "Application", - "value": "ShortNotes.Read.All" - }, - { - "description": "Allows the app to read, create, edit, and delete all the short notes without a signed-in user.", - "displayName": "Read, create, edit, and delete all users' short notes", - "id": "842c284c-763d-4a97-838d-79787d129bab", - "origin": "Application", - "value": "ShortNotes.ReadWrite.All" - }, - { - "description": "Allows the app to read your organization's conditional access policies, without a signed-in user.", - "displayName": "Read your organization's conditional access policies", - "id": "37730810-e9ba-4e46-b07e-8ca78d182097", - "origin": "Application", - "value": "Policy.Read.ConditionalAccess" - }, - { - "description": "Allows the app to read role-based access control (RBAC) settings for all RBAC providers without a signed-in user. This includes reading role definitions and role assignments.", - "displayName": "Read role management data for all RBAC providers", - "id": "c7fbd983-d9aa-4fa7-84b8-17382c103bc4", - "origin": "Application", - "value": "RoleManagement.Read.All" - }, - { - "description": "Allows the app to read all PSTN and direct routing call log data without a signed-in user.", - "displayName": "Read PSTN and direct routing call log data", - "id": "a2611786-80b3-417e-adaa-707d4261a5f0", - "origin": "Application", - "value": "CallRecord-PstnCalls.Read.All" - }, - { - "description": "Allows the app to read all one-to-one and group chats messages in Microsoft Teams, without a signed-in user.", - "displayName": "Read all chat messages", - "id": "b9bb2381-47a4-46cd-aafb-00cb12f68504", - "origin": "Application", - "value": "ChatMessage.Read.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall all tabs for any chat, without a signed-in user.", - "displayName": "Allow the Teams app to manage all tabs for all chats", - "id": "fd9ce730-a250-40dc-bd44-8dc8d20f39ea", - "origin": "Application", - "value": "TeamsTab.ReadWriteForChat.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall all tabs in any team, without a signed-in user.", - "displayName": "Allow the Teams app to manage all tabs for all teams", - "id": "6163d4f4-fbf8-43da-a7b4-060fe85ed148", - "origin": "Application", - "value": "TeamsTab.ReadWriteForTeam.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall all tabs for any user, without a signed-in user.", - "displayName": "Allow the app to manage all tabs for all users", - "id": "425b4b59-d5af-45c8-832f-bb0b7402348a", - "origin": "Application", - "value": "TeamsTab.ReadWriteForUser.All" - }, - { - "description": "Allows the app to read the API connectors used in user authentication flows, without a signed-in user.", - "displayName": "Read API connectors for authentication flows", - "id": "b86848a7-d5b1-41eb-a9b4-54a4e6306e97", - "origin": "Application", - "value": "APIConnectors.Read.All" - }, - { - "description": "Allows the app to read, create and manage the API connectors used in user authentication flows, without a signed-in user.", - "displayName": "Read and write API connectors for authentication flows", - "id": "1dfe531a-24a6-4f1b-80f4-7a0dc5a0a171", - "origin": "Application", - "value": "APIConnectors.ReadWrite.All" - }, - { - "description": "Read the members of all chats, without a signed-in user.", - "displayName": "Read the members of all chats", - "id": "a3410be2-8e48-4f32-8454-c29a7465209d", - "origin": "Application", - "value": "ChatMember.Read.All" - }, - { - "description": "Add and remove members from all chats, without a signed-in user.", - "displayName": "Add and remove members from all chats", - "id": "57257249-34ce-4810-a8a2-a03adf0c5693", - "origin": "Application", - "value": "ChatMember.ReadWrite.All" - }, - { - "description": "Allows the app to create chats without a signed-in user.\u00a0", - "displayName": "Create chats", - "id": "d9c48af6-9ad9-47ad-82c3-63757137b9af", - "origin": "Application", - "value": "Chat.Create" - }, - { - "description": "Allows the application to read tenant-wide print settings without a signed-in user.", - "displayName": "Read tenant-wide print settings", - "id": "b5991872-94cf-4652-9765-29535087c6d8", - "origin": "Application", - "value": "PrintSettings.Read.All" - }, - { - "description": "Allows an app to read and write all browser site lists configured for your organization, without a signed-in user.", - "displayName": "Read and write all browser site lists for your organization", - "id": "8349ca94-3061-44d5-9bfb-33774ea5e4f9", - "origin": "Application", - "value": "BrowserSiteLists.ReadWrite.All" - }, - { - "description": "Allows the application to read and change the tenant-level settings of SharePoint and OneDrive, without a signed-in user.", - "displayName": "Read and change SharePoint and OneDrive tenant settings", - "id": "19b94e34-907c-4f43-bde9-38b1909ed408", - "origin": "Application", - "value": "SharePointTenantSettings.ReadWrite.All" - }, - { - "description": "Allows the app to read your organization's authentication event listeners without a signed-in user.", - "displayName": "Read all authentication event listeners", - "id": "b7f6385c-6ce6-4639-a480-e23c42ed9784", - "origin": "Application", - "value": "EventListener.Read.All" - }, - { - "description": "Allows the app to read or write your organization's authentication event listeners without a signed-in user.", - "displayName": "Read and write all authentication event listeners", - "id": "0edf5e9e-4ce8-468a-8432-d08631d18c43", - "origin": "Application", - "value": "EventListener.ReadWrite.All" - }, - { - "description": "Allows the app to read your organization's custom authentication extensions without a signed-in user.", - "displayName": "Read all custom authentication extensions", - "id": "88bb2658-5d9e-454f-aacd-a3933e079526", - "origin": "Application", - "value": "CustomAuthenticationExtension.Read.All" - }, - { - "description": "Allows the app to read all users\u2019 tasks and task lists in your organization, without a signed-in user.", - "displayName": "Read all users\u2019 tasks and tasklist", - "id": "f10e1f91-74ed-437f-a6fd-d6ae88e26c1f", - "origin": "Application", - "value": "Tasks.Read.All" - }, - { - "description": "Allows the app to create, update, list, read and delete all workflows, tasks and related lifecycle workflows resources without a signed-in user.", - "displayName": "Read and write all lifecycle workflows resources", - "id": "5c505cf4-8424-4b8e-aa14-ee06e3bb23e3", - "origin": "Application", - "value": "LifecycleWorkflows.ReadWrite.All" - }, - { - "description": "Allows an app to read all bookmarks without a signed-in user.", - "displayName": "Read all bookmarks", - "id": "be95e614-8ef3-49eb-8464-1c9503433b86", - "origin": "Application", - "value": "Bookmark.Read.All" - }, - { - "description": "Allows the application to obtain basic tenant information about another target tenant within the Azure AD ecosystem without a signed-in user.", - "displayName": "Read cross-tenant basic information", - "id": "cac88765-0581-4025-9725-5ebc13f729ee", - "origin": "Application", - "value": "CrossTenantInformation.ReadBasic.All" - }, - { - "description": "Allows the application to list and query any shared user profile information associated with the current tenant without a signed-in user.\u00a0 It also permits the application to export and remove external user data (e.g. customer content or system-generated logs), for any user associated with the current tenant without a signed-in user.", - "displayName": "Read all shared cross-tenant user profiles and export or delete their data", - "id": "306785c5-c09b-4ba0-a4ee-023f3da165cb", - "origin": "Application", - "value": "CrossTenantUserProfileSharing.ReadWrite.All" - }, - { - "description": "Allows the app to read all learning content in the organization's directory, without a signed-in user.", - "displayName": "Read all learning content", - "id": "8740813e-d8aa-4204-860e-2a0f8f84dbc8", - "origin": "Application", - "value": "LearningContent.Read.All" - }, - { - "description": "Allows the app to read and update the authentication context information in your organization without a signed-in user.", - "displayName": "Read and write all authentication context information", - "id": "a88eef72-fed0-4bf7-a2a9-f19df33f8b83", - "origin": "Application", - "value": "AuthenticationContext.ReadWrite.All" - }, - { - "description": "Allows the app to read all admin report settings, such as whether to display concealed information in reports, without a signed-in user.", - "displayName": "Read all admin report settings", - "id": "ee353f83-55ef-4b78-82da-555bfa2b4b95", - "origin": "Application", - "value": "ReportSettings.Read.All" - }, - { - "description": "Allows the app to read the members of all chats where the associated Teams application is installed, without a signed-in user.", - "displayName": "Read the members of all chats where the associated Teams application is installed.", - "id": "93e7c9e4-54c5-4a41-b796-f2a5adaacda7", - "origin": "Application", - "value": "ChatMember.Read.WhereInstalled" - }, - { - "description": "Allows the app to add and remove members from all chats where the associated Teams application is installed, without a signed-in user.", - "displayName": "Add and remove members from all chats where the associated Teams application is installed.", - "id": "e32c2cd9-0124-4e44-88fc-772cd98afbdb", - "origin": "Application", - "value": "ChatMember.ReadWrite.WhereInstalled" - }, - { - "description": "Allows the app to read your organization's threat submissions and to view threat submission policies without a signed-in user.", - "displayName": "Read all of the organization's threat submissions", - "id": "86632667-cd15-4845-ad89-48a88e8412e1", - "origin": "Application", - "value": "ThreatSubmission.Read.All" - }, - { - "description": "Allows an app to sign digests for data without a signed-in user.", - "displayName": "Sign digests for data", - "id": "cbe6c7e4-09aa-4b8d-b3c3-2dbb59af4b54", - "origin": "Application", - "value": "InformationProtectionContent.Sign.All" - }, - { - "description": "Allows the app to read your organization's threat submission policies without a signed-in user. Also allows the app to create new threat submission polices without a signed-in user.", - "displayName": "Read and write all of the organization's threat submission policies", - "id": "926a6798-b100-4a20-a22f-a4918f13951d", - "origin": "Application", - "value": "ThreatSubmissionPolicy.ReadWrite.All" - }, - { - "description": "Allows the app to read all one-to-one or group chat messages in Microsoft Teams for chats where the associated Teams application is installed, without a signed-in user.", - "displayName": "Read all chat messages for chats where the associated Teams application is installed.", - "id": "1c1b4c8e-3cc7-4c58-8470-9b92c9d5848b", - "origin": "Application", - "value": "Chat.Read.WhereInstalled" - }, - { - "description": "Allows the app to read and write all chat messages in Microsoft Teams for chats where the associated Teams application is installed, without a signed-in user.", - "displayName": "Read and write all chat messages for chats where the associated Teams application is installed.", - "id": "ad73ce80-f3cd-40ce-b325-df12c33df713", - "origin": "Application", - "value": "Chat.ReadWrite.WhereInstalled" - }, - { - "description": "Allows the app to read and update all Azure AD recommendations, without a signed-in user. ", - "displayName": "Read and update all Azure AD recommendations", - "id": "0e9eea12-4f01-45f6-9b8d-3ea4c8144158", - "origin": "Application", - "value": "DirectoryRecommendations.ReadWrite.All" - }, - { - "description": "Allows the app to read all recordings of all online meetings, without a signed-in user.", - "displayName": "Read all recordings of online meetings.", - "id": "a4a08342-c95d-476b-b943-97e100569c8d", - "origin": "Application", - "value": "OnlineMeetingRecording.Read.All" - }, - { - "description": "Allows an app to manage license assignments for users and groups, without a signed-in user.", - "displayName": "Manage all license assignments", - "id": "5facf0c1-8979-4e95-abcf-ff3d079771c0", - "origin": "Application", - "value": "LicenseAssignment.ReadWrite.All" - }, - { - "description": "Allows the app to read and write the Teams app settings without a signed-in user.", - "displayName": "Read and write Teams app settings", - "id": "ab5b445e-8f10-45f4-9c79-dd3f8062cc4e", - "origin": "Application", - "value": "TeamworkAppSettings.ReadWrite.All" - }, - { - "description": "Allows the app to read and write the lifecycle information like employeeLeaveDateTime of users in your organization, without a signed-in user.", - "displayName": "Read and write all users' lifecycle information", - "id": "925f1248-0f97-47b9-8ec8-538c54e01325", - "origin": "Application", - "value": "User-LifeCycleInfo.ReadWrite.All" - }, - { - "description": "Allows the app to read all Azure AD recommendations, without a signed-in user. ", - "displayName": "Read all Azure AD recommendations", - "id": "ae73097b-cb2a-4447-b064-5d80f6093921", - "origin": "Application", - "value": "DirectoryRecommendations.Read.All" - }, - { - "description": "Allows the application to list and query any shared user profile information associated with the current tenant without a signed-in user.\u00a0 It also permits the application to export external user data (e.g. customer content or system-generated logs), for any user associated with the current tenant without a signed-in user.", - "displayName": "Read all shared cross-tenant user profiles and export their data", - "id": "8b919d44-6192-4f3d-8a3b-f86f8069ae3c", - "origin": "Application", - "value": "CrossTenantUserProfileSharing.Read.All" - }, - { - "description": "Allows the app to manage restricted resources based on the other permissions granted to the app, without a signed-in user.", - "displayName": "Manage restricted resources in the directory", - "id": "f20584af-9290-4153-9280-ff8bb2c0ea7f", - "origin": "Application", - "value": "Directory.Write.Restricted" - }, - { - "description": "Allows the app to read all transcripts of all online meetings, without a signed-in user.", - "displayName": "Read all transcripts of online meetings.", - "id": "a4a80d8d-d283-4bd8-8504-555ec3870630", - "origin": "Application", - "value": "OnlineMeetingTranscript.Read.All" - }, - { - "description": "Allows\u00a0the\u00a0app\u00a0to\u00a0manage all learning\u00a0content\u00a0in\u00a0the\u00a0organization's\u00a0directory, without a signed-in user.", - "displayName": "Manage all\u00a0learning\u00a0content", - "id": "444d6fcb-b738-41e5-b103-ac4f2a2628a3", - "origin": "Application", - "value": "LearningContent.ReadWrite.All" - }, - { - "description": "Allows the application to read the tenant-level settings of SharePoint and OneDrive, without a signed-in user.", - "displayName": "Read SharePoint and OneDrive tenant settings", - "id": "83d4163d-a2d8-4d3b-9695-4ae3ca98f888", - "origin": "Application", - "value": "SharePointTenantSettings.Read.All" - }, - { - "description": "Allows the app to read or write your organization's custom authentication extensions without a signed-in user.", - "displayName": "Read and write all custom authentication extensions", - "id": "c2667967-7050-4e7e-b059-4cbbb3811d03", - "origin": "Application", - "value": "CustomAuthenticationExtension.ReadWrite.All" - }, - { - "description": "Allows the app to read names and members of all one-to-one and group chats in Microsoft Teams where the associated Teams application is installed, without a signed-in user.", - "displayName": "Read names and members of all chat threads where the associated Teams application is installed.", - "id": "818ba5bd-5b3e-4fe0-bbe6-aa4686669073", - "origin": "Application", - "value": "Chat.ReadBasic.WhereInstalled" - }, - { - "description": "Allows the app to list and read all workflows, tasks and related lifecycle workflows resources without a signed-in user.", - "displayName": "Read all lifecycle workflows resources", - "id": "7c67316a-232a-4b84-be22-cea2c0906404", - "origin": "Application", - "value": "LifecycleWorkflows.Read.All" - }, - { - "description": "Allows the app to create protected content without a signed-in user. ", - "displayName": "Create protected content", - "id": "287bd98c-e865-4e8c-bade-1a85523195b9", - "origin": "Application", - "value": "InformationProtectionContent.Write.All" - }, - { - "description": "Allows the app to create, read, update and delete all users\u2019 tasks and task lists in your organization, without a signed-in user", - "displayName": "Read and write all users\u2019 tasks and tasklists", - "id": "44e666d1-d276-445b-a5fc-8815eeb81d55", - "origin": "Application", - "value": "Tasks.ReadWrite.All" - }, - { - "description": "Allows the app to read the Teams app settings without a signed-in user.", - "displayName": "Read Teams app settings", - "id": "475ebe88-f071-4bd7-af2b-642952bd4986", - "origin": "Application", - "value": "TeamworkAppSettings.Read.All" - }, - { - "description": "Allows the app to read the authentication context information in your organization without a signed-in user.", - "displayName": "Read all authentication context information", - "id": "381f742f-e1f8-4309-b4ab-e3d91ae4c5c1", - "origin": "Application", - "value": "AuthenticationContext.Read.All" - }, - { - "description": "Allows the app to read and update all admin report settings, such as whether to display concealed information in reports, without a signed-in user.", - "displayName": "Read and write all admin report settings", - "id": "2a60023f-3219-47ad-baa4-40e17cd02a1d", - "origin": "Application", - "value": "ReportSettings.ReadWrite.All" - }, - { - "description": "Allows an app to read all browser site lists configured for your organization, without a signed-in user.", - "displayName": "Read all browser site lists for your organization", - "id": "c5ee1f21-fc7f-4937-9af0-c91648ff9597", - "origin": "Application", - "value": "BrowserSiteLists.Read.All" - }, - { - "description": "Allows the app to read the lifecycle information like employeeLeaveDateTime of users in your organization, without a signed-in user.", - "displayName": "Read all users' lifecycle information", - "id": "8556a004-db57-4d7a-8b82-97a13428e96f", - "origin": "Application", - "value": "User-LifeCycleInfo.Read.All" - }, - { - "description": "Allows an app to read all acronyms without a signed-in user.", - "displayName": "Read all acronyms", - "id": "8c0aed2c-0c61-433d-b63c-6370ddc73248", - "origin": "Application", - "value": "Acronym.Read.All" - }, - { - "description": "Allows the app to see your users' basic profile (e.g., name, picture, user name, email address)", - "displayName": "View users' basic profile", - "id": "14dad69e-099b-42c9-810b-d002981feec1", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to see your basic profile (e.g., name, picture, user name, email address)", - "userConsentDisplayName": "View your basic profile", - "value": "profile" - }, - { - "description": "Allows the app to read attack simulation and training data for an organization for the signed-in user.", - "displayName": "Read attack simulation data of an organization", - "id": "104a7a4b-ca76-4677-b7e7-2f4bc482f381", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read attack simulation and training data for an organization on your behalf.", - "userConsentDisplayName": "Read attack simulation data of an organization", - "value": "AttackSimulation.Read.All" - }, - { - "description": "Allows the app to read and write your organization's directory access review default policy on behalf of the signed-in user.", - "displayName": "Read and write your organization's directory access review default policy", - "id": "4f5bc9c8-ea54-4772-973a-9ca119cb0409", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's directory access review default policy on your behalf.", - "userConsentDisplayName": "Read and write your organization's directory access review default policy", - "value": "Policy.ReadWrite.AccessReview" - }, - { - "description": "Allows the app to read your organization's threat submissions and threat submission policies on behalf of the signed-in user. Also allows the app to create new threat submissions on behalf of the signed-in user.", - "displayName": "Read and write all threat submissions", - "id": "8458e264-4eb9-4922-abe9-768d58f13c7f", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization's threat submissions and threat submission policies on your behalf. Also allows the app to create new threat submissions on your behalf.", - "userConsentDisplayName": "Read and write all threat submissions", - "value": "ThreatSubmission.ReadWrite.All" - }, - { - "description": "Allows the application to read any data from Records Management, such as configuration, labels, and policies on behalf of the signed-in user.", - "displayName": "Read Records Management configuration,\u00a0labels, and policies", - "id": "07f995eb-fc67-4522-ad66-2b8ca8ea3efd", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read any data from Records Management, such as configuration, labels and policies on your behalf.", - "userConsentDisplayName": "Read Records Management configuration,\u00a0labels, and policies", - "value": "RecordsManagement.Read.All" - }, - { - "description": "Allow the application to create, update and delete any data from Records Management, such as configuration, labels, and policies on behalf of the signed-in user.", - "displayName": "Read and write Records Management configuration, labels, and policies", - "id": "f2833d75-a4e6-40ab-86d4-6dfe73c97605", - "Origin": "Delegated", - "userConsentDescription": "Allow the application to create, update and delete any data from Records Management, such as configuration, labels, and policies on your behalf.", - "userConsentDisplayName": "Read and write Records Management configuration, labels, and policies", - "value": "RecordsManagement.ReadWrite.All" - }, - { - "description": "Allows the app to read details of delegated admin relationships with customers like access details (that includes roles) and the duration as well as specific role assignments to security groups on behalf of the signed-in user.", - "displayName": "Read Delegated Admin relationships with customers", - "id": "0c0064ea-477b-4130-82a5-4c2cc4ff68aa", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read details of Delegated Admin relationships with customers like access details (that includes roles) and the duration as well as specific role assignments to security groups on your behalf.", - "userConsentDisplayName": "Read Delegated Admin relationships with customers", - "value": "DelegatedAdminRelationship.Read.All" - }, - { - "description": "Allows the app to manage (create-update-terminate) Delegated Admin relationships with customers as well as role assignments to security groups for active Delegated Admin relationships on behalf of the signed-in user.", - "displayName": "Manage Delegated Admin relationships with customers", - "id": "885f682f-a990-4bad-a642-36736a74b0c7", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage (create-update-terminate) Delegated Admin relationships with customers and role assignments to security groups for active Delegated Admin relationships on your behalf.", - "userConsentDisplayName": "Manage Delegated Admin relationships with customers", - "value": "DelegatedAdminRelationship.ReadWrite.All" - }, - { - "description": "Allows the app to read and write all managed tenant information on behalf of the signed-in user.", - "displayName": "Read and write all managed tenant information", - "id": "b31fa710-c9b3-4d9e-8f5e-8036eecddab9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write all managed tenant information on your behalf.", - "userConsentDisplayName": "Read and write all managed tenant information", - "value": "ManagedTenants.ReadWrite.All" - }, - { - "description": "Allows the app to read all managed tenant information on behalf of the signed-in user.", - "displayName": "Read all managed tenant information", - "id": "dc34164e-6c4a-41a0-be89-3ae2fbad7cd3", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all managed tenant information on your behalf.", - "userConsentDisplayName": "Read all managed tenant information", - "value": "ManagedTenants.Read.All" - }, - { - "description": "Allows the app to read and manage the Cloud PC role-based access control (RBAC) settings, on behalf of the signed-in user. This includes reading and managing Cloud PC role definitions and role assignments.", - "displayName": "Read and write Cloud PC RBAC settings", - "id": "501d06f8-07b8-4f18-b5c6-c191a4af7a82", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and manage the Cloud PC role-based access control (RBAC) settings, on your behalf. This includes reading and managing Cloud PC role definitions and memberships.", - "userConsentDisplayName": "Read and write Cloud PC RBAC settings", - "value": "RoleManagement.ReadWrite.CloudPC" - }, - { - "description": "Allows the app to read the Cloud PC role-based access control (RBAC) settings, on behalf of the signed-in user.\u00a0 This includes reading Cloud PC role definitions and role assignments.", - "displayName": "Read Cloud PC RBAC settings", - "id": "9619b88a-8a25-48a7-9571-d23be0337a79", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the Cloud PC role-based access control (RBAC) settings, on your behalf.\u00a0 This includes reading Cloud PC role definitions and role assignments.", - "userConsentDisplayName": "Read Cloud PC RBAC settings", - "value": "RoleManagement.Read.CloudPC" - }, - { - "description": "Allows the app to read and write settings of external connections on behalf of a signed-in user. The signed-in user must be an administrator. The app can only read and write settings of connections that it is authorized to.", - "displayName": "Read and write external connections", - "id": "4082ad95-c812-4f02-be92-780c4c4f1830", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write external connections on your behalf. The signed-in user must be an administrator. The app can only read and write external connections that it is authorized to, or it can create new external connections. ", - "userConsentDisplayName": "Read and write external connections", - "value": "ExternalConnection.ReadWrite.OwnedBy" - }, - { - "description": "Allows the app to read all external connections on behalf of a signed-in user. The signed-in user must be an administrator.", - "displayName": "Read all external connections", - "id": "a38267a5-26b6-4d76-9493-935b7599116b", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all external connections on your behalf. The signed-in user must be an administrator.", - "userConsentDisplayName": "Read all external connections", - "value": "ExternalConnection.Read.All" - }, - { - "description": "Allows the app to read and write all external connections on behalf of a signed-in user. The signed-in user must be an administrator.", - "displayName": "Read and write all external connections", - "id": "bbbbd9b3-3566-4931-ac37-2b2180d9e334", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write all external connections on your behalf. The signed-in user must be an administrator.", - "userConsentDisplayName": "Read and write all external connections", - "value": "ExternalConnection.ReadWrite.All" - }, - { - "description": "Allows the app to read and write external items on behalf of a signed-in user. The signed-in user must be an administrator. The app can only read external items of the connection that it is authorized to.", - "displayName": "Read and write external items", - "id": "4367b9d7-cee7-4995-853c-a0bdfe95c1f9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write external items on your behalf. The signed-in user must be an administrator. The app can only read external items of the connection that it is authorized to.", - "userConsentDisplayName": "Read and write external items", - "value": "ExternalItem.ReadWrite.OwnedBy" - }, - { - "description": "Allows the app to read and write all external items on behalf of a signed-in user. The signed-in user must be an administrator.", - "displayName": "Read and write all external items", - "id": "b02c54f8-eb48-4c50-a9f0-a149e5a2012f", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write all external items on your behalf. The signed-in user must be an administrator.", - "userConsentDisplayName": "Read and write all external items", - "value": "ExternalItem.ReadWrite.All" - }, - { - "description": "Allows the app to read custom security attribute assignments for all principals in the tenant on behalf of a signed in user.", - "displayName": "Read custom security attribute assignments", - "id": "b46ffa80-fe3d-4822-9a1a-c200932d54d0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read custom security attribute assignments for all principals in the tenant on your behalf.", - "userConsentDisplayName": "Read custom security attribute assignments", - "value": "CustomSecAttributeAssignment.Read.All" - }, - { - "description": "Allows the app to read custom security attribute definitions for the tenant on behalf of a signed in user.", - "displayName": "Read custom security attribute definitions", - "id": "ce026878-a0ff-4745-a728-d4fedd086c07", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read custom security attribute definitions for the tenant on your behalf.", - "userConsentDisplayName": "Read custom security attribute definitions", - "value": "CustomSecAttributeDefinition.Read.All" - }, - { - "description": "Allows the app to read and write your organization's cross tenant access policies on behalf of the signed-in user.", - "displayName": "Read and write your organization's cross tenant access policies", - "id": "014b43d0-6ed4-4fc6-84dc-4b6f7bae7d85", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's cross tenant access policies on your behalf.", - "userConsentDisplayName": "Read and write your organization's cross tenant access policies", - "value": "Policy.ReadWrite.CrossTenantAccess" - }, - { - "description": "Allows the app to read and write tags in Teams, on behalf of the signed-in user.", - "displayName": "Read and write tags in Teams", - "id": "539dabd7-b5b6-4117-b164-d60cd15a8671", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write tags in Teams, on your behalf.", - "userConsentDisplayName": "Read and write tags in Teams", - "value": "TeamworkTag.ReadWrite" - }, - { - "description": "Allows the app to read tags in Teams, on behalf of the signed-in user.", - "displayName": "Read tags in Teams", - "id": "57587d0b-8399-45be-b207-8050cec54575", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read tags in Teams, on your behalf.", - "userConsentDisplayName": "Read tags in Teams", - "value": "TeamworkTag.Read" - }, - { - "description": "Allows the app to read and write security incidents, on behalf of the signed-in user.", - "displayName": "Read and write to incidents", - "id": "128ca929-1a19-45e6-a3b8-435ec44a36ba", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write to all security incidents that you have access to.", - "userConsentDisplayName": "Read and write to security incidents", - "value": "SecurityIncident.ReadWrite.All" - }, - { - "description": "Allows the app to read security incidents, on behalf of the signed-in user.", - "displayName": "Read incidents", - "id": "b9abcc4f-94fc-4457-9141-d20ce80ec952", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all security incidents that you have access to.", - "userConsentDisplayName": "Read security incidents", - "value": "SecurityIncident.Read.All" - }, - { - "description": "Allows the app to read and write to all security alerts, on behalf of the signed-in user.", - "displayName": "Read and write to all security alerts", - "id": "471f2a7f-2a42-4d45-a2bf-594d0838070d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write all alerts that you have access to.", - "userConsentDisplayName": "Read and write all alerts", - "value": "SecurityAlert.ReadWrite.All" - }, - { - "description": "Allows the app to read all security alerts, on behalf of the signed-in user.", - "displayName": "Read all security alerts", - "id": "bc257fb8-46b4-4b15-8713-01e91bfbe4ea", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all security alerts that you have access to.", - "userConsentDisplayName": "Read all alerts", - "value": "SecurityAlert.Read.All" - }, - { - "description": "Allows the app to update service announcement messages' user status on behalf of the signed-in user. The message status can be marked as read, archive, or favorite.", - "displayName": "Update user status on service announcement messages", - "id": "636e1b0b-1cc2-4b1c-9aa9-4eeed9b9761b", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to update service announcement messages' status on your behalf. Your status for messages can be marked as read, archive, or favorite.", - "userConsentDisplayName": "Update your user status on service announcement messages", - "value": "ServiceMessageViewpoint.Write" - }, - { - "description": "Allows the app to run hunting queries, on behalf of the signed-in user.", - "displayName": "Run hunting queries", - "id": "b152eca8-ea73-4a48-8c98-1a6742673d99", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to run hunting queries that you can execute.", - "userConsentDisplayName": "Run hunting queries", - "value": "ThreatHunting.Read.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall itself to teams the signed-in user can access.", - "displayName": "Allow the app to manage itself in teams", - "id": "0f4595f7-64b1-4e13-81bc-11a249df07a9", - "Origin": "Delegated", - "userConsentDescription": "Allows a Teams app to read, install, upgrade, and uninstall itself to teams you can access.", - "userConsentDisplayName": "Allow the Teams app to manage itself in teams", - "value": "TeamsAppInstallation.ReadWriteSelfForTeam" - }, - { - "description": "Allow the app to read the management data for Teams devices on behalf of the signed-in user.", - "displayName": "Read Teams devices", - "id": "b659488b-9d28-4208-b2be-1c6652b3c970", - "Origin": "Delegated", - "userConsentDescription": "Allow the app to read the management data for Teams devices on your behalf.", - "userConsentDisplayName": "Read Teams devices", - "value": "TeamworkDevice.Read.All" - }, - { - "description": "Allow the app to read and write the management data for Teams devices on behalf of the signed-in user.", - "displayName": "Read and write Teams devices", - "id": "ddd97ecb-5c31-43db-a235-0ee20e635c40", - "Origin": "Delegated", - "userConsentDescription": "Allow the app to read and write the management data for Teams devices on your behalf.", - "userConsentDisplayName": "Read and write Teams devices", - "value": "TeamworkDevice.ReadWrite.All" - }, - { - "description": "Allows the app to read all identity risky service principal information for your organization, on behalf of the signed-in user.", - "displayName": "Read all identity risky service principal information", - "id": "ea5c4ab0-5a73-4f35-8272-5d5337884e5d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all identity risky service principal information for your organization, on your behalf.", - "userConsentDisplayName": "Read all identity risky service principal information", - "value": "IdentityRiskyServicePrincipal.Read.All" - }, - { - "description": "Allows the app to read and update identity risky service principal information for all service principals in your organization, on behalf of the signed-in user. Update operations include dismissing risky service principals.", - "displayName": "Read and write all identity risky service principal information", - "id": "bb6f654c-d7fd-4ae3-85c3-fc380934f515", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and update identity risky service principal information for all service principals in your organization, on your behalf. Update operations include dismissing risky service principals.", - "userConsentDisplayName": "Read and write all identity risky service principal information", - "value": "IdentityRiskyServicePrincipal.ReadWrite.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall its own tabs to teams the signed-in user can access.", - "displayName": "Allow the Teams app to manage only its own tabs in teams", - "id": "f266662f-120a-4314-b26a-99b08617c7ef", - "Origin": "Delegated", - "userConsentDescription": "Allows a Teams app to read, install, upgrade, and uninstall its own tabs to teams you can access.", - "userConsentDisplayName": "Allow the Teams app to manage only its own tabs in teams", - "value": "TeamsTab.ReadWriteSelfForTeam" - }, - { - "description": "Allows the app to read the presence information and write activity and availability on behalf of the signed-in user. Presence information includes activity, availability, status note, calendar out-of-office message, timezone and location.", - "displayName": "Read and write a user's presence information", - "id": "8d3c54a7-cf58-4773-bf81-c0cd6ad522bb", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the presence information and write activity and availability on your behalf. Presence information includes activity, availability, status note, calendar out-of-office message, timezone and location.", - "userConsentDisplayName": "Read and write your presence information", - "value": "Presence.ReadWrite" - }, - { - "description": "Allows the app to read subject rights requests on behalf of the signed-in user", - "displayName": "Read subject rights requests", - "id": "9c3af74c-fd0f-4db4-b17a-71939e2a9d77", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read subject rights requests on your behalf.", - "userConsentDisplayName": "Read data subject requests", - "value": "SubjectRightsRequest.Read.All" - }, - { - "description": "Allows the app to read and write subject rights requests on behalf of the signed-in user", - "displayName": "Read and write subject rights requests", - "id": "2b8fcc74-bce1-4ae3-a0e8-60c53739299d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write subject rights requests on your behalf.", - "userConsentDisplayName": "Read and write data subject requests", - "value": "SubjectRightsRequest.ReadWrite.All" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall its own tabs for the signed-in user.", - "displayName": "Allow the Teams app to manage only its own tabs for a user", - "id": "395dfec1-a0b9-465f-a783-8250a430cb8c", - "Origin": "Delegated", - "userConsentDescription": "Allows a Teams app to read, install, upgrade, and uninstall its own tabs for you.", - "userConsentDisplayName": "Allow the Teams app to manage only its own tabs for you", - "value": "TeamsTab.ReadWriteSelfForUser" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall its own tabs in chats the signed-in user can access.", - "displayName": "Allow the Teams app to manage only its own tabs in chats", - "id": "0c219d04-3abf-47f7-912d-5cca239e90e6", - "Origin": "Delegated", - "userConsentDescription": "Allows a Teams app to read, install, upgrade, and uninstall its own tabs in chats you can access.", - "userConsentDisplayName": "Allow the Teams app to manage only its own tabs in chats", - "value": "TeamsTab.ReadWriteSelfForChat" - }, - { - "description": "Allows the app to read and write search configuration, on behalf of the signed-in user.", - "displayName": "Read and write your organization's search configuration", - "id": "b1a7d408-cab0-47d2-a2a5-a74a3733600d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write search configuration, on your behalf.", - "userConsentDisplayName": "Read and write your organization's search configuration", - "value": "SearchConfiguration.ReadWrite.All" - }, - { - "description": "Allows the app to read search configuration, on behalf of the signed-in user.", - "displayName": "Read your organization's search configuration", - "id": "7d307522-aa38-4cd0-bd60-90c6f0ac50bd", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read search configuration, on your behalf.", - "userConsentDisplayName": "Read your organization's search configuration", - "value": "SearchConfiguration.Read.All" - }, - { - "description": "Allows the app to read online meeting artifacts on behalf of the signed-in user.", - "displayName": "Read user's online meeting artifacts", - "id": "110e5abb-a10c-4b59-8b55-9b4daa4ef743", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read online meeting artifacts on your behalf.", - "userConsentDisplayName": "Read user's online meeting artifacts", - "value": "OnlineMeetingArtifact.Read.All" - }, - { - "description": "Allows the app to read and manage the active role-based access control (RBAC) assignments for your company's directory, on behalf of the signed-in user. This includes managing active directory role membership, and reading directory role templates, directory roles and active memberships.", - "displayName": "Read, update, and delete all active role assignments for your company's directory", - "id": "8c026be3-8e26-4774-9372-8d5d6f21daff", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and manage the active role-based access control (RBAC) assignments for your company's directory, on your behalf. This includes managing active directory role membership, and reading directory role templates, directory roles and active memberships.", - "userConsentDisplayName": "Read, update, and delete all active role assignments for your company's directory", - "value": "RoleAssignmentSchedule.ReadWrite.Directory" - }, - { - "description": "Allows the app to read and manage the eligible role-based access control (RBAC) assignments for your company's directory, on behalf of the signed-in user. This includes managing eligible directory role membership, and reading directory role templates, directory roles and eligible memberships.", - "displayName": "Read, update, and delete all eligible role assignments for your company's directory", - "id": "62ade113-f8e0-4bf9-a6ba-5acb31db32fd", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and manage the eligible role-based access control (RBAC) assignments for your company's directory, on your behalf. This includes managing eligible directory role membership, and reading directory role templates, directory roles and eligible memberships.", - "userConsentDisplayName": "Read, update, and delete all eligible role assignments for your company's directory", - "value": "RoleEligibilitySchedule.ReadWrite.Directory" - }, - { - "description": "Allows the app to read, update, and delete policies for privileged role-based access control (RBAC) assignments of your company's directory, on behalf of the signed-in user.", - "displayName": "Read, update, and delete all policies for privileged role assignments of your company's directory", - "id": "1ff1be21-34eb-448c-9ac9-ce1f506b2a68", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, and delete policies for privileged role-based access control (RBAC) assignments of your company's directory, on your behalf.", - "userConsentDisplayName": "Read, update, and delete all policies for privileged role assignments of your company's directory", - "value": "RoleManagementPolicy.ReadWrite.Directory" - }, - { - "description": "Allows the app to read the active role-based access control (RBAC) assignments for your company's directory, on behalf of the signed-in user. This includes reading directory role templates, and directory roles.", - "displayName": "Read all active role assignments for your company's directory", - "id": "344a729c-0285-42c6-9014-f12b9b8d6129", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the active role-based access control (RBAC) assignments for your company's directory, on your behalf. This includes reading directory role templates, and directory roles.", - "userConsentDisplayName": "Read all active role assignments for your company's directory", - "value": "RoleAssignmentSchedule.Read.Directory" - }, - { - "description": "Allows the app to read the eligible role-based access control (RBAC) assignments for your company's directory, on behalf of the signed-in user. This includes reading directory role templates, and directory roles.", - "displayName": "Read all eligible role assignments for your company's directory", - "id": "eb0788c2-6d4e-4658-8c9e-c0fb8053f03d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the eligible role-based access control (RBAC) assignments for your company's directory, on your behalf. This includes reading directory role templates, and directory roles.", - "userConsentDisplayName": "Read all eligible role assignments for your company's directory", - "value": "RoleEligibilitySchedule.Read.Directory" - }, - { - "description": "Allows the app to read policies for privileged role-based access control (RBAC) assignments of your company's directory, on behalf of the signed-in user.", - "displayName": "Read all policies for privileged role assignments of your company's directory", - "id": "3de2cdbe-0ff5-47d5-bdee-7f45b4749ead", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read policies for privileged role-based access control (RBAC) assignments of your company's directory, on your behalf.", - "userConsentDisplayName": "Read all policies for privileged role assignments of your company's directory", - "value": "RoleManagementPolicy.Read.Directory" - }, - { - "description": "Allows the app to read and write all Windows update deployment settings for the organization on behalf of the signed-in user.", - "displayName": "Read and write all Windows update deployment settings", - "id": "11776c0c-6138-4db3-a668-ee621bea2555", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write all Windows update deployment settings for the organization on your behalf.", - "userConsentDisplayName": "Read and write all Windows update deployment settings", - "value": "WindowsUpdates.ReadWrite.All" - }, - { - "description": "Allows the app to read and write your organization's mobility management policies on behalf of the signed-in user. For example, a mobility management policy can set the enrollment scope for a given mobility management application.", - "displayName": "Read and write your organization's mobility management policies", - "id": "a8ead177-1889-4546-9387-f25e658e2a79", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's mobility management policies on your behalf. For example, a mobility management policy can set the enrollment scope for a given mobility management application.", - "userConsentDisplayName": "Read and write your organization's mobility management policies", - "value": "Policy.ReadWrite.MobilityManagement" - }, - { - "description": "Allows the app to read basic unified group properties, memberships and owners of the group the signed-in guest is a member of.", - "displayName": "Read unified group memberships as guest", - "id": "73e75199-7c3e-41bb-9357-167164dbb415", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read basic unified group properties, memberships and owners of the group you are a member of.", - "userConsentDisplayName": "Read unified group memberships as guest", - "value": "UnifiedGroupMember.Read.AsGuest" - }, - { - "description": "Allows the app to update service principal endpoints", - "displayName": "Read and update service principal endpoints", - "id": "7297d82c-9546-4aed-91df-3d4f0a9b3ff0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to update service principal endpoints", - "userConsentDisplayName": "Read and update service principal endpoints", - "value": "ServicePrincipalEndpoint.ReadWrite.All" - }, - { - "description": "Allows the app to read service principal endpoints", - "displayName": "Read service principal endpoints", - "id": "9f9ce928-e038-4e3b-8faf-7b59049a8ddc", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read service principal endpoints", - "userConsentDisplayName": "Read service principal endpoints", - "value": "ServicePrincipalEndpoint.Read.All" - }, - { - "description": "Allows the app to create new notifications in users' teamwork activity feeds on behalf of the signed in user. These notifications may not be discoverable or be held or governed by compliance policies.", - "displayName": "Send a teamwork activity as the user", - "id": "7ab1d787-bae7-4d5d-8db6-37ea32df9186", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create new activities in your teamwork activity feed, and send new activities to other users' activity feed, on your behalf.", - "userConsentDisplayName": "Send a teamwork activity", - "value": "TeamsActivity.Send" - }, - { - "description": "Allows the app to read and write eDiscovery objects such as cases, custodians, review sets and other related objects on behalf of the signed-in user.", - "displayName": "Read and write all eDiscovery objects", - "id": "acb8f680-0834-4146-b69e-4ab1b39745ad", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write eDiscovery objects such as cases, custodians, review sets and other related objects on your behalf.", - "userConsentDisplayName": "Read and write all eDiscovery objects", - "value": "eDiscovery.ReadWrite.All" - }, - { - "description": "Allows the app to read eDiscovery objects such as cases, custodians, review sets and other related objects on behalf of the signed-in user.", - "displayName": "Read all eDiscovery objects", - "id": "99201db3-7652-4d5a-809a-bdb94f85fe3c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read eDiscovery objects such as cases, custodians, review sets and other related objects on your behalf.", - "userConsentDisplayName": "Read all eDiscovery objects", - "value": "eDiscovery.Read.All" - }, - { - "description": "Allows the app to read and write custom security attribute assignments for all principals in the tenant on behalf of a signed in user.", - "displayName": "Read and write custom security attribute assignments", - "id": "ca46335e-8453-47cd-a001-8459884efeae", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write custom security attribute assignments for all principals in the tenant on your behalf.", - "userConsentDisplayName": "Read and write custom security attribute assignments", - "value": "CustomSecAttributeAssignment.ReadWrite.All" - }, - { - "description": "Allows the app to read and write custom security attribute definitions for the tenant on behalf of a signed in user.", - "displayName": "Read and write custom security attribute definitions", - "id": "8b0160d4-5743-482b-bb27-efc0a485ca4a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write custom security attribute definitions for the tenant on your behalf.", - "userConsentDisplayName": "Read and write custom security attribute definitions", - "value": "CustomSecAttributeDefinition.ReadWrite.All" - }, - { - "description": "Allows the app to read email in the signed-in user's mailbox except body, previewBody, attachments and any extended properties.", - "displayName": "Read user basic mail", - "id": "a4b8392a-d8d1-4954-a029-8e668a39a170", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read email in the signed-in user's mailbox except body, previewBody, attachments and any extended properties.", - "userConsentDisplayName": "Read user basic mail", - "value": "Mail.ReadBasic" - }, - { - "description": "Allows the app to read and write your organization's feature rollout policies on behalf of the signed-in user. Includes abilities to assign and remove users and groups to rollout of a specific feature.", - "displayName": "Read and write your organization's feature rollout policies", - "id": "92a38652-f13b-4875-bc77-6e1dbb63e1b2", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's feature rollout policies on your behalf. Includes abilities to assign and remove users and groups to rollout of a specific feature.", - "userConsentDisplayName": "Read and write your organization's feature rollout policies", - "value": "Policy.ReadWrite.FeatureRollout" - }, - { - "description": "Allows the app to read and manage the role-based access control (RBAC) settings for your company's directory, on behalf of the signed-in user. This includes instantiating directory roles and managing directory role membership, and reading directory role templates, directory roles and memberships.", - "displayName": "Read and write directory RBAC settings", - "id": "d01b97e9-cbc0-49fe-810a-750afd5527a3", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and manage the role-based access control (RBAC) settings for your company's directory, on your behalf. This includes instantiating directory roles and managing directory role membership, and reading directory role templates, directory roles and memberships.", - "userConsentDisplayName": "Read and write directory RBAC settings", - "value": "RoleManagement.ReadWrite.Directory" - }, - { - "description": "Allows the app to read the role-based access control (RBAC) settings for your company's directory, on behalf of the signed-in user. This includes reading directory role templates, directory roles and memberships.", - "displayName": "Read directory RBAC settings", - "id": "741c54c3-0c1e-44a1-818b-3f97ab4e8c83", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the role-based access control (RBAC) settings for your company's directory, on your behalf. This includes reading directory role templates, directory roles and memberships.", - "userConsentDisplayName": "Read directory RBAC settings", - "value": "RoleManagement.Read.Directory" - }, - { - "description": "Allows the app to read and write the organization and related resources, on behalf of the signed-in user.\u00a0Related resources include things like subscribed skus and tenant branding information.", - "displayName": "Read and write organization information", - "id": "46ca0847-7e6b-426e-9775-ea810a948356", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the organization and related resources, on your behalf.\u00a0Related resources include things like subscribed skus and tenant branding information.", - "userConsentDisplayName": "Read and write organization information", - "value": "Organization.ReadWrite.All" - }, - { - "description": "Allows the app to read the organization and related resources, on behalf of the signed-in user.\u00a0Related resources include things like subscribed skus and tenant branding information.", - "displayName": "Read organization information", - "id": "4908d5b9-3fb2-4b1e-9336-1888b7937185", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the organization and related resources, on your behalf.\u00a0Related resources include things like subscribed skus and tenant branding information.", - "userConsentDisplayName": "Read organization information", - "value": "Organization.Read.All" - }, - { - "description": "Allows the app to read your company's places (conference rooms and room lists) for calendar events and other applications, on behalf of the signed-in user.", - "displayName": "Read all company places", - "id": "cb8f45a0-5c2e-4ea1-b803-84b870a7d7ec", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your company's places (conference rooms and room lists) for calendar events and other applications, on your behalf.", - "userConsentDisplayName": "Read all company places", - "value": "Place.Read.All" - }, - { - "description": "Allows the app to manage workforce integrations, to synchronize data from Microsoft Teams Shifts, on behalf of the signed-in user.", - "displayName": "Read and write workforce integrations", - "id": "08c4b377-0d23-4a8b-be2a-23c1c1d88545", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage workforce integrations, to synchronize data from Microsoft Teams Shifts, on your behalf.", - "userConsentDisplayName": "Read and write workforce integrations", - "value": "WorkforceIntegration.ReadWrite.All" - }, - { - "description": "Allows the app to read workforce integrations, to synchronize data from Microsoft Teams Shifts, on behalf of the signed-in user.", - "displayName": "Read workforce integrations", - "id": "f1ccd5a7-6383-466a-8db8-1a656f7d06fa", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read workforce integrations, to synchronize data from Microsoft Teams Shifts, on your behalf.", - "userConsentDisplayName": "Read workforce integrations", - "value": "WorkforceIntegration.Read.All" - }, - { - "description": "Allows the app to read, update, delete and perform actions on access reviews, reviewers, decisions and settings for group and app memberships that the signed-in user has access to in the organization.", - "displayName": "Manage access reviews for group and app memberships", - "id": "5af8c3f5-baca-439a-97b0-ea58a435e269", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update and perform action on access reviews, reviewers, decisions and settings that you have access to.", - "userConsentDisplayName": "Manage access reviews for group and app memberships", - "value": "AccessReview.ReadWrite.Membership" - }, - { - "description": "Allows the app to manage hybrid identity service configuration by creating, viewing, updating and deleting on-premises published resources, on-premises agents and agent groups, on behalf of the signed-in user.", - "displayName": "Manage on-premises published resources", - "id": "8c4d5184-71c2-4bf8-bb9d-bc3378c9ad42", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage hybrid identity service configuration by creating, viewing, updating and deleting on-premises published resources, on-premises agents and agent groups, on your behalf.", - "userConsentDisplayName": "Manage on-premises published resources", - "value": "OnPremisesPublishingProfiles.ReadWrite.All" - }, - { - "description": "Allows an app to read information protection sensitivity labels and label policy settings, on behalf of the signed-in user.", - "displayName": "Read user sensitivity labels and label policies.", - "id": "4ad84827-5578-4e18-ad7a-86530b12f884", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read information protection sensitivity labels and label policy settings, on behalf of the signed-in user.", - "userConsentDisplayName": "Read user sensitivity labels and label policies.", - "value": "InformationProtectionPolicy.Read" - }, - { - "description": "Allows the app to read administrative units and administrative unit membership on behalf of the signed-in user.", - "displayName": "Read administrative units", - "id": "3361d15d-be43-4de6-b441-3c746d05163d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read administrative units and administrative unit membership on your behalf.", - "userConsentDisplayName": "Read administrative units", - "value": "AdministrativeUnit.Read.All" - }, - { - "description": "Allows the app to create, read, update, and delete administrative units and manage administrative unit membership on behalf of the signed-in user.", - "displayName": "Read and write administrative units", - "id": "7b8a2d34-6b3f-4542-a343-54651608ad81", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create, read, update, and delete administrative units and manage administrative unit membership on your behalf.", - "userConsentDisplayName": "Read and write administrative units", - "value": "AdministrativeUnit.ReadWrite.All" - }, - { - "description": "Allows the app to read your family information, members and their basic profile.", - "displayName": "Read your family info", - "id": "3a1e4806-a744-4c70-80fc-223bf8582c46", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your family information, members and their basic profile.", - "userConsentDisplayName": "Read your family info", - "value": "Family.Read" - }, - { - "description": "Allows the app to create threat indicators, and fully manage those threat indicators (read, update and delete), on behalf of the signed-in user. \u00a0It cannot update any threat indicators it does not own.", - "displayName": "Manage threat indicators this app creates or owns", - "id": "91e7d36d-022a-490f-a748-f8e011357b42", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create threat indicators, and fully manage those threat indicators (read, update and delete), on your behalf. \u00a0It cannot update any threat indicators that it is not an owner of.", - "userConsentDisplayName": "Manage threat indicators this app creates or owns", - "value": "ThreatIndicators.ReadWrite.OwnedBy" - }, - { - "description": "Allows the app to read or update security actions, on behalf of the signed-in user.", - "displayName": "Read and update your organization's security actions", - "id": "dc38509c-b87d-4da0-bd92-6bec988bac4a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and update security actions, on your behalf.", - "userConsentDisplayName": "Read and update your organization's security actions", - "value": "SecurityActions.ReadWrite.All" - }, - { - "description": "Allows the app to read security actions, on behalf of the signed-in user.", - "displayName": "Read your organization's security actions", - "id": "1638cddf-07a4-4de2-8645-69c96cacad73", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read security actions, on your behalf.", - "userConsentDisplayName": "Read your organization's security actions", - "value": "SecurityActions.Read.All" - }, - { - "description": "Allows an app to read 1 on 1 or group chats threads, on behalf of the signed-in user.", - "displayName": "Read user chat messages", - "id": "f501c180-9344-439a-bca0-6cbf209fd270", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read your 1 on 1 or group chat messages in Microsoft Teams, on your behalf.", - "userConsentDisplayName": "Read your chat messages", - "value": "Chat.Read" - }, - { - "description": "Allows an app to read and write 1 on 1 or group chats threads, on behalf of the signed-in user.", - "displayName": "Read and write user chat messages", - "id": "9ff7295e-131b-4d94-90e1-69fde507ac11", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read and write your 1 on 1 or group chat messages in Microsoft Teams, on your behalf.", - "userConsentDisplayName": "Read and write your chat messages", - "value": "Chat.ReadWrite" - }, - { - "description": "Allows the app to read and write your organization's trust framework policies on behalf of the signed-in user.", - "displayName": "Read and write your organization's trust framework policies", - "id": "cefba324-1a70-4a6e-9c1d-fd670b7ae392", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's trust framework policies on your behalf.", - "userConsentDisplayName": "Read and write trust framework policies", - "value": "Policy.ReadWrite.TrustFramework" - }, - { - "description": "Allows the app to read trust framework key set properties on behalf of the signed-in user.", - "displayName": "Read trust framework key sets", - "id": "7ad34336-f5b1-44ce-8682-31d7dfcd9ab9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read trust framework key sets, on your behalf.", - "userConsentDisplayName": "Read trust framework key sets", - "value": "TrustFrameworkKeySet.Read.All" - }, - { - "description": "Allows the app to read and write trust framework key set properties on behalf of the signed-in user.", - "displayName": "Read and write trust framework key sets", - "id": "39244520-1e7d-4b4a-aee0-57c65826e427", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read or write trust framework key sets, on your behalf.", - "userConsentDisplayName": "Read and write trust framework key sets", - "value": "TrustFrameworkKeySet.ReadWrite.All" - }, - { - "description": "Allows the app to read and update identity risk event information for all users in your organization on behalf of the signed-in user.\u00a0Update operations include confirming risk event detections.\u00a0", - "displayName": "Read and write risk event information", - "id": "9e4862a5-b68f-479e-848a-4e07e25c9916", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and update identity risk event information for all users in your organization on your behalf.\u00a0Update operations include confirming risk event detections.\u00a0", - "userConsentDisplayName": "Read and write risk event information", - "value": "IdentityRiskEvent.ReadWrite.All" - }, - { - "description": "Allows the app to read and update identity risky user information for all users in your organization on behalf of the signed-in user.\u00a0Update operations include dismissing risky users.", - "displayName": "Read and write risky user information", - "id": "e0a7cdbb-08b0-4697-8264-0069786e9674", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and update identity risky user information for all users in your organization on your behalf.\u00a0Update operations include dismissing risky users.", - "userConsentDisplayName": "Read and write identity risky user information", - "value": "IdentityRiskyUser.ReadWrite.All" - }, - { - "description": "Allows the app to read the signed-in user's mailbox.", - "displayName": "Read user mail ", - "id": "570282fd-fa5c-430d-a7fd-fc8dc98a9dca", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read email in your mailbox. ", - "userConsentDisplayName": "Read your mail ", - "value": "Mail.Read" - }, - { - "description": "Allows the app to read identity risky user information for all users in your organization on behalf of the signed-in user.", - "displayName": "Read identity risky user information", - "id": "d04bb851-cb7c-4146-97c7-ca3e71baf56c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read identity risky user information for all users in your organization on behalf of the signed-in user.", - "userConsentDisplayName": "Read identity risky user information", - "value": "IdentityRiskyUser.Read.All" - }, - { - "description": "Allows the app to read the signed-in user's activity statistics, such as how much time the user has spent on emails, in meetings, or in chat sessions.", - "displayName": "Read user activity statistics", - "id": "e03cf23f-8056-446a-8994-7d93dfc8b50e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your activity statistics, such as how much time you've spent on emails, in meetings, or in chat sessions.", - "userConsentDisplayName": "Read your activity statistics", - "value": "Analytics.Read" - }, - { - "description": "Allows the app to see and update the data you gave it access to, even when users are not currently using the app. This does not give the app any additional permissions.", - "displayName": "Maintain access to data you have given it access to", - "id": "7427e0e9-2fba-42fe-b0c0-848c9e6a8182", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to see and update the data you gave it access to, even when you are not currently using the app. This does not give the app any additional permissions.", - "userConsentDisplayName": "Maintain access to data you have given it access to", - "value": "offline_access" - }, - { - "description": "Allows the app to have the same access to mailboxes as the signed-in user via Exchange Web Services.", - "displayName": "Access mailboxes as the signed-in user via Exchange Web Services", - "id": "9769c687-087d-48ac-9cb3-c37dde652038", - "Origin": "Delegated", - "userConsentDescription": "Allows the app full access to your mailboxes on your behalf.", - "userConsentDisplayName": "Access your mailboxes", - "value": "EWS.AccessAsUser.All" - }, - { - "description": "Allows the app to export data (e.g. customer content or system-generated logs), associated with any user in your company, when the app is used by a privileged user (e.g. a Company Administrator).", - "displayName": "Export user's data", - "id": "405a51b5-8d8d-430b-9842-8be4b0e9f324", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to export data (e.g. customer content or system-generated logs), associated with any user in your company, when the app is used by a privileged user (e.g. a Company Administrator).", - "userConsentDisplayName": "Export user's data", - "value": "User.Export.All" - }, - { - "description": "Allows the app to deliver its notifications on behalf of signed-in users. Also allows the app to read, update, and delete the user's notification items for this app.", - "displayName": "Deliver and manage user notifications for this app", - "id": "89497502-6e42-46a2-8cb2-427fd3df970a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to deliver its notifications, on your behalf. Also allows the app to read, update, and delete your notification items for this app.", - "userConsentDisplayName": "Deliver and manage your notifications for this app", - "value": "Notifications.ReadWrite.CreatedByApp" - }, - { - "description": "Allows the app to read and write your organization's conditional access policies on behalf of the signed-in user.", - "displayName": "Read and write your organization's conditional access policies", - "id": "ad902697-1014-4ef5-81ef-2b4301988e8c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's conditional access policies on your behalf.", - "userConsentDisplayName": "Read and write your organization's conditional access policies", - "value": "Policy.ReadWrite.ConditionalAccess" - }, - { - "description": "Allows the app to read your organization's policies on behalf of the signed-in user.", - "displayName": "Read your organization's policies", - "id": "572fea84-0151-49b2-9301-11cb16974376", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization's policies on your behalf.", - "userConsentDisplayName": "Read your organization's policies", - "value": "Policy.Read.All" - }, - { - "description": "Allows the app to read access reviews, reviewers, decisions and settings that the signed-in user has access to in the organization.", - "displayName": "Read all access reviews that user can access", - "id": "ebfcd32b-babb-40f4-a14b-42706e83bd28", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read information on access reviews, reviewers, decisions and settings that you have access to.", - "userConsentDisplayName": "Read access reviews that you can access", - "value": "AccessReview.Read.All" - }, - { - "description": "Allows the app to read, update, delete and perform actions on access reviews, reviewers, decisions and settings that the signed-in user has access to in the organization.", - "displayName": "Manage all access reviews that user can access", - "id": "e4aa47b9-9a69-4109-82ed-36ec70d85ff1", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update and perform action on access reviews, reviewers, decisions and settings that you have access to.", - "userConsentDisplayName": "Manage access reviews that you can access", - "value": "AccessReview.ReadWrite.All" - }, - { - "description": "Allows the app to read programs and program controls that the signed-in user has access to in the organization.", - "displayName": "Read all programs that user can access", - "id": "c492a2e1-2f8f-4caa-b076-99bbf6e40fe4", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read information on programs and program controls that you have access to.", - "userConsentDisplayName": "Read programs that you can access", - "value": "ProgramControl.Read.All" - }, - { - "description": "Allows the app to read, update, delete and perform actions on programs and program controls that the signed-in user has access to in the organization.", - "displayName": "Manage all programs that user can access", - "id": "50fd364f-9d93-4ae1-b170-300e87cccf84", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update and perform action on programs and program controls that you have access to.", - "userConsentDisplayName": "Manage programs that you can access", - "value": "ProgramControl.ReadWrite.All" - }, - { - "description": "Allows the app to create, read, update, and delete apps in the app catalogs.", - "displayName": "Read and write to all app catalogs", - "id": "1ca167d5-1655-44a1-8adf-1414072e1ef9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create, read, update, and delete apps in the app catalogs.", - "userConsentDisplayName": "Read and write to all app catalogs", - "value": "AppCatalog.ReadWrite.All" - }, - { - "description": "Allows the app to request and manage just in time elevation (including scheduled elevation) of users to Azure AD built-in administrative roles, on behalf of signed-in users.", - "displayName": "Read and write privileged access to Azure AD", - "id": "3c3c74f5-cdaa-4a97-b7e0-4e788bfcfb37", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to request and manage just in time elevation (including scheduled elevation) of users to Azure AD built-in administrative roles, on your behalf.", - "userConsentDisplayName": "Read and write privileged access to Azure AD", - "value": "PrivilegedAccess.ReadWrite.AzureAD" - }, - { - "description": "Allows the app to read terms of use agreements on behalf of the signed-in user.", - "displayName": "Read all terms of use agreements", - "id": "af2819c9-df71-4dd3-ade7-4d7c9dc653b7", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read terms of use agreements on your behalf.", - "userConsentDisplayName": "Read all terms of use agreements", - "value": "Agreement.Read.All" - }, - { - "description": "Allows the app to read and write terms of use agreements on behalf of the signed-in user.", - "displayName": "Read and write all terms of use agreements", - "id": "ef4b5d93-3104-4664-9053-a5c49ab44218", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write terms of use agreements on your behalf.", - "userConsentDisplayName": "Read and write all terms of use agreements", - "value": "Agreement.ReadWrite.All" - }, - { - "description": "Allows the app to read terms of use acceptance statuses on behalf of the signed-in user.", - "displayName": "Read user terms of use acceptance statuses", - "id": "0b7643bb-5336-476f-80b5-18fbfbc91806", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your terms of use acceptance statuses.", - "userConsentDisplayName": "Read your terms of use acceptance statuses", - "value": "AgreementAcceptance.Read" - }, - { - "description": "Allows the app to read terms of use acceptance statuses on behalf of the signed-in user.", - "displayName": "Read terms of use acceptance statuses that user can access", - "id": "a66a5341-e66e-4897-9d52-c2df58c2bfb9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read terms of use acceptance statuses on your behalf.", - "userConsentDisplayName": "Read all terms of use acceptance statuses", - "value": "AgreementAcceptance.Read.All" - }, - { - "description": "Read activity data for your organization", - "displayName": "Allows the application to read activity data for your organization.", - "id": "594c1fb6-4f81-4475-ae41-0c394909246c", - "Origin": "Delegated (Office 365 Management)", - "userConsentDescription": "Read activity data for your organization", - "userConsentDisplayName": "Allows the application to read activity data for your organization.", - "value": "ActivityFeed.Read" - }, - { - "description": "Allows the app to read and query your audit log activities, on behalf of the signed-in user.", - "displayName": "Read audit log data", - "id": "e4c9e354-4dc5-45b8-9e7c-e1393b0b1a20", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and query your audit log activities, on your behalf.", - "userConsentDisplayName": "Read audit log data", - "value": "AuditLog.Read.All" - }, - { - "description": "Allows the app to read and report the signed-in user's activity in the app.", - "displayName": "Read and write app activity to users' activity feed", - "id": "47607519-5fb1-47d9-99c7-da4b48f369b1", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and report your activity in the app.", - "userConsentDisplayName": "Read and write app activity to your activity feed", - "value": "UserActivity.ReadWrite.CreatedByApp" - }, - { - "description": "Allows the app to read properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups.", - "displayName": "Read Microsoft Intune Device Configuration and Policies", - "id": "f1493658-876a-4c87-8fa7-edb559b3476a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups.", - "userConsentDisplayName": "Read Microsoft Intune Device Configuration and Policies", - "value": "DeviceManagementConfiguration.Read.All" - }, - { - "description": "Allows the app to read and write properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups.", - "displayName": "Read and write Microsoft Intune Device Configuration and Policies", - "id": "0883f392-0a7a-443d-8c76-16a6d39c7b63", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups.", - "userConsentDisplayName": "Read and write Microsoft Intune Device Configuration and Policies", - "value": "DeviceManagementConfiguration.ReadWrite.All" - }, - { - "description": "Allows the app to read the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune.", - "displayName": "Read Microsoft Intune apps", - "id": "4edf5f54-4666-44af-9de9-0144fb4b6e8c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune.", - "userConsentDisplayName": "Read Microsoft Intune apps", - "value": "DeviceManagementApps.Read.All" - }, - { - "description": "Allows the app to read and write the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune.", - "displayName": "Read and write Microsoft Intune apps", - "id": "7b3f05d5-f68c-4b8d-8c59-a2ecd12f24af", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune.", - "userConsentDisplayName": "Read and write Microsoft Intune apps", - "value": "DeviceManagementApps.ReadWrite.All" - }, - { - "description": "Allows the app to read the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings.", - "displayName": "Read Microsoft Intune RBAC settings", - "id": "49f0cc30-024c-4dfd-ab3e-82e137ee5431", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings.", - "userConsentDisplayName": "Read Microsoft Intune RBAC settings", - "value": "DeviceManagementRBAC.Read.All" - }, - { - "description": "Allows the app to read and write the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings.", - "displayName": "Read and write Microsoft Intune RBAC settings", - "id": "0c5e8a55-87a6-4556-93ab-adc52c4d862d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings.", - "userConsentDisplayName": "Read and write Microsoft Intune RBAC settings", - "value": "DeviceManagementRBAC.ReadWrite.All" - }, - { - "description": "Allows the app to read the properties of devices managed by Microsoft Intune.", - "displayName": "Read Microsoft Intune devices", - "id": "314874da-47d6-4978-88dc-cf0d37f0bb82", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the properties of devices managed by Microsoft Intune.", - "userConsentDisplayName": "Read devices Microsoft Intune devices", - "value": "DeviceManagementManagedDevices.Read.All" - }, - { - "description": "Allows the app to read and write the properties of devices managed by Microsoft Intune. Does not allow high impact operations such as remote wipe and password reset on the device\u2019s owner.", - "displayName": "Read and write Microsoft Intune devices", - "id": "44642bfe-8385-4adc-8fc6-fe3cb2c375c3", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the properties of devices managed by Microsoft Intune. Does not allow high impact operations such as remote wipe and password reset on the device\u2019s owner.", - "userConsentDisplayName": "Read and write Microsoft Intune devices", - "value": "DeviceManagementManagedDevices.ReadWrite.All" - }, - { - "description": "Allows the app to perform remote high impact actions such as wiping the device or resetting the passcode on devices managed by Microsoft Intune.", - "displayName": "Perform user-impacting remote actions on Microsoft Intune devices", - "id": "3404d2bf-2b13-457e-a330-c24615765193", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to perform remote high impact actions such as wiping the device or resetting the passcode on devices managed by Microsoft Intune.", - "userConsentDisplayName": "Perform user-impacting remote actions on Microsoft Intune devices", - "value": "DeviceManagementManagedDevices.PrivilegedOperations.All" - }, - { - "description": "Allows the app to read and write Microsoft Intune service properties including device enrollment and third party service connection configuration.", - "displayName": "Read and write Microsoft Intune configuration", - "id": "662ed50a-ac44-4eef-ad86-62eed9be2a29", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write Microsoft Intune service properties including device enrollment and third party service connection configuration.", - "userConsentDisplayName": "Read and write Microsoft Intune configuration", - "value": "DeviceManagementServiceConfig.ReadWrite.All" - }, - { - "description": "Allows the app to read Microsoft Intune service properties including device enrollment and third party service connection configuration.", - "displayName": "Read Microsoft Intune configuration", - "id": "8696daa5-bce5-4b2e-83f9-51b6defc4e1e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read Microsoft Intune service properties including device enrollment and third party service connection configuration.", - "userConsentDisplayName": "Read Microsoft Intune configuration", - "value": "DeviceManagementServiceConfig.Read.All" - }, - { - "description": "Allows the app to read your organization\u2019s security events on behalf of the signed-in user.", - "displayName": "Read your organization\u2019s security events", - "id": "64733abd-851e-478a-bffb-e47a14b18235", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization\u2019s security events on your behalf.", - "userConsentDisplayName": "Read your organization\u2019s security events", - "value": "SecurityEvents.Read.All" - }, - { - "description": "Allows the app to read your organization\u2019s security events on behalf of the signed-in user. Also allows the app to update editable properties in security events on behalf of the signed-in user.", - "displayName": "Read and update your organization\u2019s security events", - "id": "6aedf524-7e1c-45a7-bd76-ded8cab8d0fc", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization\u2019s security events on your behalf. Also allows you to update editable properties in security events.", - "userConsentDisplayName": "Read and update your organization\u2019s security events", - "value": "SecurityEvents.ReadWrite.All" - }, - { - "description": "Allows the app to read a scored list of relevant people of the signed-in user or other users in the signed-in user's organization. The list can include local contacts, contacts from social networking, your organization's directory, and people from recent communications (such as email and Skype).", - "displayName": "Read all users' relevant people lists", - "id": "b89f9189-71a5-4e70-b041-9887f0bc7e4a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read a list of people in the order that is most relevant to you. Allows the app to read a list of people in the order that is most relevant to another user in your organization. These can include local contacts, contacts from social networking, people listed in your organization\u2019s directory, and people from recent communications.", - "userConsentDisplayName": "Read all users\u2019 relevant people lists", - "value": "People.Read.All" - }, - { - "description": "Manage the state and settings of all Microsoft education apps on behalf of the user.", - "displayName": "Manage education app settings", - "id": "63589852-04e3-46b4-bae9-15d5b1050748", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage the state and settings of all Microsoft education apps on your behalf.", - "userConsentDisplayName": "Manage your education app settings", - "value": "EduAdministration.ReadWrite" - }, - { - "description": "Read the state and settings of all Microsoft education apps on behalf of the user.", - "displayName": "Read education app settings", - "id": "8523895c-6081-45bf-8a5d-f062a2f12c9f", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to view the state and settings of all Microsoft education apps on your behalf.", - "userConsentDisplayName": "View your education app settings", - "value": "EduAdministration.Read" - }, - { - "description": "Allows the app to read and write assignments and their grades on behalf of the user.", - "displayName": "Read and write users' class assignments and their grades", - "id": "2f233e90-164b-4501-8bce-31af2559a2d3", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to view and modify your assignments on your behalf including \u00a0grades.", - "userConsentDisplayName": "View and modify your assignments and grades", - "value": "EduAssignments.ReadWrite" - }, - { - "description": "Allows the app to read assignments and their grades on behalf of the user.", - "displayName": "Read users' class assignments and their grades", - "id": "091460c9-9c4a-49b2-81ef-1f3d852acce2", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to view your assignments on your behalf including grades.", - "userConsentDisplayName": "View your assignments and grades", - "value": "EduAssignments.Read" - }, - { - "description": "Allows the app to read and write assignments without grades on behalf of the user.", - "displayName": "Read and write users' class assignments without grades", - "id": "2ef770a1-622a-47c4-93ee-28d6adbed3a0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to view and modify your assignments on your behalf without seeing grades.", - "userConsentDisplayName": "View and modify your assignments without grades", - "value": "EduAssignments.ReadWriteBasic" - }, - { - "description": "Allows the app to read assignments without grades on behalf of the user.", - "displayName": "Read users' class assignments without grades", - "id": "c0b0103b-c053-4b2e-9973-9f3a544ec9b8", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to view your assignments on your behalf without seeing grades.", - "userConsentDisplayName": "View your assignments without grades", - "value": "EduAssignments.ReadBasic" - }, - { - "description": "Allows the app to read and write the structure of schools and classes in an organization's roster and education-specific information about users to be read and written on behalf of the user.", - "displayName": "Read and write users' view of the roster", - "id": "359e19a6-e3fa-4d7f-bcab-d28ec592b51e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to view and modify information about schools and classes in your organization and education-related information about you and other users on your behalf.", - "userConsentDisplayName": "View and modify your school, class and user information", - "value": "EduRoster.ReadWrite" - }, - { - "description": "Allows the app to read the structure of schools and classes in an organization's roster and education-specific information about users to be read on behalf of the user.", - "displayName": "Read users' view of the roster", - "id": "a4389601-22d9-4096-ac18-36a927199112", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to view information about schools and classes in your organization and education-related information about you and other users on your behalf.", - "userConsentDisplayName": "View your school, class and user information", - "value": "EduRoster.Read" - }, - { - "description": "Allows the app to read a limited subset of the properties from the structure of schools and classes in an organization's roster and a limited subset of properties about users to be read on behalf of the user.\u00a0Includes name, status, education role, email address and photo.", - "displayName": "Read a limited subset of users' view of the roster", - "id": "5d186531-d1bf-4f07-8cea-7c42119e1bd9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to view minimal \u00a0information about both schools and classes in your organization and education-related information about you and other users on your behalf.", - "userConsentDisplayName": "View a limited subset of your school, class and user information", - "value": "EduRoster.ReadBasic" - }, - { - "description": "Allows the app to report the signed-in user's app activity information to Microsoft Timeline.", - "displayName": "Write app activity to users' timeline", - "id": "367492fc-594d-4972-a9b5-0d58c622c91c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to report your app activity information to Microsoft Timeline.", - "userConsentDisplayName": "Write app activity to your timeline", - "value": "UserTimelineActivity.Write.CreatedByApp" - }, - { - "description": "Allows the app to create, read, update, and delete user's mailbox settings. Does not include permission to send mail.", - "displayName": "Read and write user mailbox settings", - "id": "818c620a-27a9-40bd-a6a5-d96f7d610b4b", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create, and delete your mailbox settings.", - "userConsentDisplayName": "Read and write to your mailbox settings", - "value": "MailboxSettings.ReadWrite" - }, - { - "description": "Allows the app to launch another app or communicate with another app on a user's device on behalf of the signed-in user.", - "displayName": "Communicate with user devices", - "id": "bac3b9c2-b516-4ef4-bd3b-c2ef73d8d804", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to launch another app or communicate with another app on a device that you own.", - "userConsentDisplayName": "Communicate with your other devices", - "value": "Device.Command" - }, - { - "description": "Allows the app to read a user's list of devices on behalf of the signed-in user.", - "displayName": "Read user devices", - "id": "11d4cd79-5ba5-460f-803f-e22c8ab85ccd", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to see your list of devices.", - "userConsentDisplayName": "View your list of devices", - "value": "Device.Read" - }, - { - "description": "Allows the app to read, share, and modify OneNote notebooks that the signed-in user has access to in the organization.", - "displayName": "Read and write all OneNote notebooks that user can access", - "id": "64ac0503-b4fa-45d9-b544-71a463f05da0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, share, and modify all the OneNote notebooks that you have access to.", - "userConsentDisplayName": "Read and write all OneNote notebooks that you can access", - "value": "Notes.ReadWrite.All" - }, - { - "description": "Allows the app to read OneNote notebooks that the signed-in user has access to in the organization.", - "displayName": "Read all OneNote notebooks that user can access", - "id": "dfabfca6-ee36-4db2-8208-7a28381419b3", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all the OneNote notebooks that you have access to.", - "userConsentDisplayName": "Read all OneNote notebooks that you can access", - "value": "Notes.Read.All" - }, - { - "description": "Allows the app to read, share, and modify OneNote notebooks on behalf of the signed-in user.", - "displayName": "Read and write user OneNote notebooks", - "id": "615e26af-c38a-4150-ae3e-c3b0d4cb1d6a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, share, and modify OneNote notebooks on your behalf.", - "userConsentDisplayName": "Read and write your OneNote notebooks", - "value": "Notes.ReadWrite" - }, - { - "description": "Allows the app to read OneNote notebooks on behalf of the signed-in user.", - "displayName": "Read user OneNote notebooks", - "id": "371361e4-b9e2-4a3f-8315-2a301a3b0a3d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read OneNote notebooks on your behalf.", - "userConsentDisplayName": "Read your OneNote notebooks", - "value": "Notes.Read" - }, - { - "description": "This is deprecated! Do not use! This permission no longer has any effect. You can safely consent to it. No additional privileges will be granted to the app.", - "displayName": "Limited notebook access (deprecated)", - "id": "ed68249d-017c-4df5-9113-e684c7f8760b", - "Origin": "Delegated", - "userConsentDescription": "This permission no longer has any effect. You can safely consent to it. No additional privileges will be granted to the app.", - "userConsentDisplayName": "Limited access to your OneNote notebooks for this app (preview)", - "value": "Notes.ReadWrite.CreatedByApp" - }, - { - "description": "Allows the app to read the titles of OneNote notebooks and sections and to create new pages, notebooks, and sections on behalf of the signed-in user.", - "displayName": "Create user OneNote notebooks", - "id": "9d822255-d64d-4b7a-afdb-833b9a97ed02", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to view the titles of your OneNote notebooks and sections and to create new pages, notebooks, and sections on your behalf.", - "userConsentDisplayName": "Create your OneNote notebooks", - "value": "Notes.Create" - }, - { - "description": "Allows the app to invite guest users to the organization, on behalf of the signed-in user.", - "displayName": "Invite guest users to the organization", - "id": "63dd7cd9-b489-4adf-a28c-ac38b9a0f962", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to invite guest users to the organization, on your behalf.", - "userConsentDisplayName": "Invite guest users to the organization", - "value": "User.Invite.All" - }, - { - "description": "Allows the app to the read user's mailbox settings. Does not include permission to send mail.", - "displayName": "Read user mailbox settings", - "id": "87f447af-9fa4-4c32-9dfa-4a57a73d18ce", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your mailbox settings.", - "userConsentDisplayName": "Read your mailbox settings", - "value": "MailboxSettings.Read" - }, - { - "description": "(Preview) Allows the app to read files that the user selects. The app has access for several hours after the user selects a file.", - "displayName": "Read files that the user selects (preview)", - "id": "5447fe39-cb82-4c1a-b977-520e67e724eb", - "Origin": "Delegated", - "userConsentDescription": "(Preview) Allows the app to read files that you select. After you select a file, the app has access to the file for several hours.", - "userConsentDisplayName": "Read selected files", - "value": "Files.Read.Selected" - }, - { - "description": "(Preview) Allows the app to read and write files that the user selects. The app has access for several hours after the user selects a file.", - "displayName": "Read and write files that the user selects (preview)", - "id": "17dde5bd-8c17-420f-a486-969730c1b827", - "Origin": "Delegated", - "userConsentDescription": "(Preview) Allows the app to read and write files that you select. After you select a file, the app has access to the file for several hours.", - "userConsentDisplayName": "Read and write selected files", - "value": "Files.ReadWrite.Selected" - }, - { - "description": "(Preview) Allows the app to read, create, update and delete files in the application's folder.", - "displayName": "Have full access to the application's folder (preview)", - "id": "8019c312-3263-48e6-825e-2b833497195b", - "Origin": "Delegated", - "userConsentDescription": "(Preview) Allows the app to read, create, update and delete files in the application's folder.", - "userConsentDisplayName": "Have full access to the application's folder", - "value": "Files.ReadWrite.AppFolder" - }, - { - "description": "Allows an app to read all service usage reports on behalf of the signed-in user. Services that provide usage reports include Office 365 and Azure Active Directory.", - "displayName": "Read all usage reports", - "id": "02e97553-ed7b-43d0-ab3c-f8bace0d040c", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read all service usage reports on your behalf. Services that provide usage reports include Office 365 and Azure Active Directory.", - "userConsentDisplayName": "Read all usage reports", - "value": "Reports.Read.All" - }, - { - "description": "Allows the application to edit or delete documents and list items in all site collections on behalf of the signed-in user.", - "displayName": "Edit or delete items in all site collections", - "id": "89fe6a52-be36-487e-b7d8-d061c450a026", - "Origin": "Delegated", - "userConsentDescription": "Allow the application to edit or delete documents and list items in all site collections on your behalf.", - "userConsentDisplayName": "Edit or delete items in all site collections", - "value": "Sites.ReadWrite.All" - }, - { - "description": "Allows the app to create, read, update, and delete tasks a user has permissions to, including their own and shared tasks.", - "displayName": "Read and write user and shared tasks", - "id": "c5ddf11b-c114-4886-8558-8a4e557cd52b", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create, and delete tasks you have permissions to access, including your own and shared tasks.", - "userConsentDisplayName": "Read and write to your and shared tasks", - "value": "Tasks.ReadWrite.Shared" - }, - { - "description": "Allows the app to read tasks a user has permissions to access, including their own and shared tasks.", - "displayName": "Read user and shared tasks", - "id": "88d21fd4-8e5a-4c32-b5e2-4a1c95f34f72", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read tasks you have permissions to access, including your own and shared tasks.", - "userConsentDisplayName": "Read your and shared tasks", - "value": "Tasks.Read.Shared" - }, - { - "description": "Allows the app to create, read, update, and delete contacts a user has permissions to, including their own and shared contacts.", - "displayName": "Read and write user and shared contacts", - "id": "afb6c84b-06be-49af-80bb-8f3f77004eab", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create, and delete contacts you have permissions to access, including your own and shared contacts.", - "userConsentDisplayName": "Read and write to your and shared contacts", - "value": "Contacts.ReadWrite.Shared" - }, - { - "description": "Allows the app to read contacts a user has permissions to access, including their own and shared contacts.", - "displayName": "Read user and shared contacts", - "id": "242b9d9e-ed24-4d09-9a52-f43769beb9d4", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read contacts you have permissions to access, including your own and shared contacts.", - "userConsentDisplayName": "Read your and shared contacts", - "value": "Contacts.Read.Shared" - }, - { - "description": "Allows the app to create, read, update and delete events in all calendars in the organization user has permissions to access. This includes delegate and shared calendars.", - "displayName": "Read and write user and shared calendars", - "id": "12466101-c9b8-439a-8589-dd09ee67e8e9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create and delete events in all calendars in your organization you have permissions to access. This includes delegate and shared calendars.", - "userConsentDisplayName": "Read and write to your and shared calendars", - "value": "Calendars.ReadWrite.Shared" - }, - { - "description": "Allows the app to read events in all calendars that the user can access, including delegate and shared calendars.", - "displayName": "Read user and shared calendars", - "id": "2b9c4092-424d-4249-948d-b43879977640", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read events in all calendars that you can access, including delegate and shared calendars.\u00a0", - "userConsentDisplayName": "Read calendars\u00a0you can access", - "value": "Calendars.Read.Shared" - }, - { - "description": "Allows the app to send mail as the signed-in user, including sending on-behalf of others.", - "displayName": "Send mail on behalf of others", - "id": "a367ab51-6b49-43bf-a716-a1fb06d2a174", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to send mail as you or on-behalf of someone else.", - "userConsentDisplayName": "Send mail on behalf of others or yourself", - "value": "Mail.Send.Shared" - }, - { - "description": "Allows the app to create, read, update, and delete mail a user has permission to access, including their own and shared mail. Does not include permission to send mail.", - "displayName": "Read and write user and shared mail", - "id": "5df07973-7d5d-46ed-9847-1271055cbd51", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create, and delete mail you have permission to access, including your own and shared mail. Does not allow the app to send mail on your behalf.", - "userConsentDisplayName": "Read and write mail\u00a0you can access", - "value": "Mail.ReadWrite.Shared" - }, - { - "description": "Allows the app to read mail a user can access, including their own and shared mail.", - "displayName": "Read user and shared mail", - "id": "7b9103a5-4610-446b-9670-80643382c1fa", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read mail you can access, including shared mail.", - "userConsentDisplayName": "Read mail you can access", - "value": "Mail.Read.Shared" - }, - { - "description": "Allows users to sign-in to the app, and allows the app to read the profile of signed-in users. It also allows the app to read basic company information of signed-in users.", - "displayName": "Sign in and read user profile", - "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d", - "Origin": "Delegated", - "userConsentDescription": "Allows you to sign in to the app with your organizational account and let the app read your profile. It also allows the app to read basic company information.", - "userConsentDisplayName": "Sign you in and read your profile", - "value": "User.Read" - }, - { - "description": "Allows the app to read your profile. It also allows the app to update your profile information on your behalf.", - "displayName": "Read and write access to user profile", - "id": "b4e74841-8e56-480b-be8b-910348b18b4c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your profile, and discover your group membership, reports and manager. It also allows the app to update your profile information on your behalf.", - "userConsentDisplayName": "Read and update your profile", - "value": "User.ReadWrite" - }, - { - "description": "Allows the app to read a basic set of profile properties of other users in your organization on behalf of the signed-in user. This includes display name, first and last name, email address and photo.", - "displayName": "Read all users' basic profiles", - "id": "b340eb25-3456-403f-be2f-af7a0d370277", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read a basic set of profile properties of other users in your organization on your behalf. Includes display name, first and last name, email address and photo.", - "userConsentDisplayName": "Read all users' basic profiles", - "value": "User.ReadBasic.All" - }, - { - "description": "Allows the app to read the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user.", - "displayName": "Read all users' full profiles", - "id": "a154be20-db9c-4678-8ab7-66f6cc099a59", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the full set of profile properties, reports, and managers of other users in your organization, on your behalf.", - "userConsentDisplayName": "Read all users' full profiles", - "value": "User.Read.All" - }, - { - "description": "Allows the app to read and write the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user.", - "displayName": "Read and write all users' full profiles", - "id": "204e0828-b5ca-4ad8-b9f3-f32a958e7cc4", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the full set of profile properties, reports, and managers of other users in your organization, on your behalf.", - "userConsentDisplayName": "Read and write all users' full profiles", - "value": "User.ReadWrite.All" - }, - { - "description": "Allows the app to list groups, and to read their properties and all group memberships on behalf of the signed-in user. Also allows the app to read calendar, conversations, files, and other group content for all groups the signed-in user can access. ", - "displayName": "Read all groups", - "id": "5f8c59db-677d-491f-a6b8-5f174b11ec1d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to list groups, and to read their properties and all group memberships on your behalf. Also allows the app to read calendar, conversations, files, and other group content for all groups you can access. ", - "userConsentDisplayName": "Read all groups", - "value": "Group.Read.All" - }, - { - "description": "Allows the app to create groups and read all group properties and memberships on behalf of the signed-in user. Additionally allows group owners to manage their groups and allows group members to update group content.", - "displayName": "Read and write all groups", - "id": "4e46008b-f24c-477d-8fff-7bb4ec7aafe0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create groups and read all group properties and memberships on your behalf. Additionally allows the app to manage your groups and to update group content for groups you are a member of.", - "userConsentDisplayName": "Read and write all groups", - "value": "Group.ReadWrite.All" - }, - { - "description": "Allows the app to read data in your organization's directory, such as users, groups and apps.", - "displayName": "Read directory data", - "id": "06da0dbc-49e2-44d2-8312-53f166ab848a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read data in your organization's directory.", - "userConsentDisplayName": "Read directory data", - "value": "Directory.Read.All" - }, - { - "description": "Allows the app to read and write data in your organization's directory, such as users, and groups. It does not allow the app to delete users or groups, or reset user passwords.", - "displayName": "Read and write directory data", - "id": "c5366453-9fb0-48a5-a156-24f0c49a4b84", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write data in your organization's directory, such as other users, groups. It does not allow the app to delete users or groups, or reset user passwords.", - "userConsentDisplayName": "Read and write directory data", - "value": "Directory.ReadWrite.All" - }, - { - "description": "Allows the app to have the same access to information in the directory as the signed-in user.", - "displayName": "Access directory as the signed in user", - "id": "0e263e50-5827-48a4-b97c-d940288653c7", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to have the same access to information in your work or school directory as you do.", - "userConsentDisplayName": "Access the directory as you", - "value": "Directory.AccessAsUser.All" - }, - { - "description": "Allows the app to create, read, update, and delete email in user mailboxes. Does not include permission to send mail. ", - "displayName": "Read and write access to user mail ", - "id": "024d486e-b451-40bb-833d-3e66d98c5c73", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create and delete email in your mailbox. Does not include permission to send mail. ", - "userConsentDisplayName": "Read and write access to your mail ", - "value": "Mail.ReadWrite" - }, - { - "description": "Allows the app to send mail as users in the organization. ", - "displayName": "Send mail as a user ", - "id": "e383f46e-2787-4529-855e-0e479a3ffac0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to send mail as you. ", - "userConsentDisplayName": "Send mail as you ", - "value": "Mail.Send" - }, - { - "description": "Allows the app to read events in user calendars . ", - "displayName": "Read user calendars ", - "id": "465a38f9-76ea-45b9-9f34-9e8b0d4b0b42", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read events in your calendars. ", - "userConsentDisplayName": "Read your calendars ", - "value": "Calendars.Read" - }, - { - "description": "Allows the app to create, read, update, and delete events in user calendars. ", - "displayName": "Have full access to user calendars ", - "id": "1ec239c2-d7c9-4623-a91a-a9775856bb36", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create and delete events in your calendars. ", - "userConsentDisplayName": "Have full access to your calendars ", - "value": "Calendars.ReadWrite" - }, - { - "description": "Allows the app to read user contacts. ", - "displayName": "Read user contacts ", - "id": "ff74d97f-43af-4b68-9f2a-b77ee6968c5d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read contacts in your contact folders. ", - "userConsentDisplayName": "Read your contacts ", - "value": "Contacts.Read" - }, - { - "description": "Allows the app to create, read, update, and delete user contacts. ", - "displayName": "Have full access to user contacts ", - "id": "d56682ec-c09e-4743-aaf4-1a3aac4caa21", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create and delete contacts in your contact folders. ", - "userConsentDisplayName": "Have full access of your contacts ", - "value": "Contacts.ReadWrite" - }, - { - "description": "Allows the app to read the signed-in user's files.", - "displayName": "Read user files", - "id": "10465720-29dd-4523-a11a-6a75c743c9d9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your files.", - "userConsentDisplayName": "Read your files", - "value": "Files.Read" - }, - { - "description": "Allows the app to read, create, update and delete the signed-in user's files.", - "displayName": "Have full access to user files", - "id": "5c28f0bf-8a70-41f1-8ab2-9032436ddb65", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, create, update, and delete your files.", - "userConsentDisplayName": "Have full access to your files", - "value": "Files.ReadWrite" - }, - { - "description": "Allows the app to read all files the signed-in user can access.", - "displayName": "Read all files that user can access", - "id": "df85f4d6-205c-4ac5-a5ea-6bf408dba283", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all files you can access.", - "userConsentDisplayName": "Read all files that you have access to", - "value": "Files.Read.All" - }, - { - "description": "Allows the app to read, create, update and delete all files the signed-in user can access.", - "displayName": "Have full access to all files user can access", - "id": "863451e7-0667-486c-a5d6-d135439485f0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, create, update and delete all files that you can access.", - "userConsentDisplayName": "Have full access to all files you have access to", - "value": "Files.ReadWrite.All" - }, - { - "description": "Allows the application to read documents and list items in all site collections on behalf of the signed-in user", - "displayName": "Read items in all site collections", - "id": "205e70e5-aba6-4c52-a976-6d2d46c48043", - "Origin": "Delegated", - "userConsentDescription": "Allow the application to read documents and list items in all site collections on your behalf", - "userConsentDisplayName": "Read items in all site collections", - "value": "Sites.Read.All" - }, - { - "description": "Allows users to sign in to the app with their work or school accounts and allows the app to see basic user profile information.", - "displayName": "Sign users in", - "id": "37f7f235-527c-4136-accd-4a02d197296e", - "Origin": "Delegated", - "userConsentDescription": "Allows you to sign in to the app with your work or school account and allows the app to read your basic profile information.", - "userConsentDisplayName": "Sign in as you", - "value": "openid" - }, - { - "description": "Allows the app to read your users' primary email address", - "displayName": "View users' email address", - "id": "64a6cdd6-aab1-4aaf-94b8-3cc8405e90d0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your primary email address", - "userConsentDisplayName": "View your email address", - "value": "email" - }, - { - "description": "Allows the app to read identity risk event information for all users in your organization on behalf of the signed-in user. ", - "displayName": "Read identity risk event information", - "id": "8f6a01e7-0391-4ee5-aa22-a3af122cef27", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read identity risk event information for all users in your organization on behalf of the signed-in user. ", - "userConsentDisplayName": "Read identity risk event information", - "value": "IdentityRiskEvent.Read.All" - }, - { - "description": "Allows the app to read the memberships of hidden groups and administrative units on behalf of the signed-in user, for those hidden groups and administrative units that the signed-in user has access to.", - "displayName": "Read hidden memberships", - "id": "f6a3db3e-f7e8-4ed2-a414-557c8c9830be", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the memberships of hidden groups or administrative units on your behalf, for those hidden groups or adminstrative units that you have access to.", - "userConsentDisplayName": "Read your hidden memberships", - "value": "Member.Read.Hidden" - }, - { - "description": "Allows the app to read a ranked list of relevant people of the signed-in user. The list includes local contacts, contacts from social networking, your organization's directory, and people from recent communications (such as email and Skype).", - "displayName": "Read users' relevant people lists", - "id": "ba47897c-39ec-4d83-8086-ee8256fa737d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read a list of people in the order that's most relevant to you. This includes your local contacts, your contacts from social networking, people listed in your organization's directory, and people from recent communications.", - "userConsentDisplayName": "Read your relevant people list", - "value": "People.Read" - }, - { - "description": "Allows the application to create or delete document libraries and lists in all site collections on behalf of the signed-in user.", - "displayName": "Create, edit, and delete items and lists in all site collections", - "id": "65e50fdc-43b7-4915-933e-e8138f11f40a", - "Origin": "Delegated", - "userConsentDescription": "Allow the application to create or delete document libraries and lists in all site collections on your behalf.", - "userConsentDisplayName": "Create, edit, and delete items and lists in all your site collections", - "value": "Sites.Manage.All" - }, - { - "description": "Allows the application to have full control of all site collections on behalf of the signed-in user.", - "displayName": "Have full control of all site collections", - "id": "5a54b8b3-347c-476d-8f8e-42d5c7424d29", - "Origin": "Delegated", - "userConsentDescription": "Allow the application to have full control of all site collections on your behalf.", - "userConsentDisplayName": "Have full control of all your site collections", - "value": "Sites.FullControl.All" - }, - { - "description": "Allows the app to read and write your organization\u2019s identity (authentication) providers\u2019 properties on behalf of the user.", - "displayName": "Read and write identity providers", - "id": "f13ce604-1677-429f-90bd-8a10b9f01325", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization\u2019s identity (authentication) providers\u2019 properties on your behalf.", - "userConsentDisplayName": "Read and write identity providers", - "value": "IdentityProvider.ReadWrite.All" - }, - { - "description": "Allows the app to read your organization\u2019s identity (authentication) providers\u2019 properties on behalf of the user.", - "displayName": "Read identity providers", - "id": "43781733-b5a7-4d1b-98f4-e8edff23e1a9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization\u2019s identity (authentication) providers\u2019 properties on your behalf.", - "userConsentDisplayName": "Read identity providers", - "value": "IdentityProvider.Read.All" - }, - { - "description": "Allows an app to read bookings appointments, businesses, customers, services, and staff on behalf of the signed-in user.", - "displayName": "Read bookings information", - "id": "33b1df99-4b29-4548-9339-7a7b83eaeebc", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read bookings appointments, businesses, customers, services, and staff on your behalf.", - "userConsentDisplayName": "Read bookings information", - "value": "Bookings.Read.All" - }, - { - "description": "Allows an app to read and write bookings appointments and customers, and additionally allows read businesses information, services, and staff on behalf of the signed-in user.", - "displayName": "Read and write booking appointments", - "id": "02a5a114-36a6-46ff-a102-954d89d9ab02", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read and write bookings appointments and customers, and additionally allows read businesses information, services, and staff on your behalf.", - "userConsentDisplayName": "Read and write booking appointments", - "value": "BookingsAppointment.ReadWrite.All" - }, - { - "description": "Allows an app to read and write bookings appointments, businesses, customers, services, and staff on behalf of the signed-in user. Does not allow create, delete and publish of booking businesses.", - "displayName": "Read and write bookings information", - "id": "948eb538-f19d-4ec5-9ccc-f059e1ea4c72", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read and write Bookings appointments, businesses, customers, services, and staff on your behalf. Does not allow create, delete and publish of booking businesses.", - "userConsentDisplayName": "Read and write bookings information", - "value": "Bookings.ReadWrite.All" - }, - { - "description": "Allows an app to read, write and manage bookings appointments, businesses, customers, services, and staff on behalf of the signed-in user.", - "displayName": "Manage bookings information", - "id": "7f36b48e-542f-4d3b-9bcb-8406f0ab9fdb", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read, write and manage bookings appointments, businesses, customers, services, and staff on your behalf.", - "userConsentDisplayName": "Manage bookings information", - "value": "Bookings.Manage.All" - }, - { - "description": "Allows the app to have the same access to mailboxes as the signed-in user via Exchange ActiveSync.", - "displayName": "Access mailboxes via Exchange ActiveSync", - "id": "ff91d191-45a0-43fd-b837-bd682c4a0b0f", - "Origin": "Delegated", - "userConsentDescription": "Allows the app full access to your mailboxes on your behalf.", - "userConsentDisplayName": "Access your mailboxes", - "value": "EAS.AccessAsUser.All" - }, - { - "description": "Allows the app to read and write financials data on behalf of the signed-in user.", - "displayName": "Read and write financials data", - "id": "f534bf13-55d4-45a9-8f3c-c92fe64d6131", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write financials data on your behalf.", - "userConsentDisplayName": "Read and write financials data", - "value": "Financials.ReadWrite.All" - }, - { - "description": "Allows the app to read your organization's user flows, on behalf of the signed-in user.", - "displayName": "Read all identity user flows", - "id": "2903d63d-4611-4d43-99ce-a33f3f52e343", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization's user flows, on your behalf.", - "userConsentDisplayName": "Read all identity user flows", - "value": "IdentityUserFlow.Read.All" - }, - { - "description": "Allows the app to read or write your organization's user flows, on behalf of the signed-in user.", - "displayName": "Read and write all identity user flows", - "id": "281892cc-4dbf-4e3a-b6cc-b21029bb4e82", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read or write your organization's user flows, on your behalf.", - "userConsentDisplayName": "Read and write all identity user flows", - "value": "IdentityUserFlow.ReadWrite.All" - }, - { - "description": "Allows the app to read all organizational contacts on behalf of the signed-in user. \u00a0These contacts are managed by the organization and are different from a user's personal contacts.", - "displayName": "Read organizational contacts", - "id": "08432d1b-5911-483c-86df-7980af5cdee0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all organizational contacts on your behalf.\u00a0 These contacts are managed by the organization and are different from your personal contacts.", - "userConsentDisplayName": "Read organizational contacts", - "value": "OrgContact.Read.All" - }, - { - "description": "Allows the app to manage permission grants for application permissions to any API (including Microsoft Graph) and application assignments for any app, on behalf of the signed-in user.", - "displayName": "Manage app permission grants and app role assignments", - "id": "84bccea3-f856-4a8a-967b-dbe0a3d53a64", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage permission grants for application permissions to any API (including Microsoft Graph) and application assignments for any app, on your behalf.", - "userConsentDisplayName": "Manage app permission grants and app role assignments", - "value": "AppRoleAssignment.ReadWrite.All" - }, - { - "description": "Allows the app to manage permission grants for delegated permissions exposed by any API (including Microsoft Graph), on behalf of the signed in user.", - "displayName": "Manage all delegated permission grants", - "id": "41ce6ca6-6826-4807-84f1-1c82854f7ee5", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage permission grants for delegated permissions exposed by any API (including Microsoft Graph), on your behalf. ", - "userConsentDisplayName": "Manage all delegated permission grants", - "value": "DelegatedPermissionGrant.ReadWrite.All" - }, - { - "description": "Allows the app to read online meeting details on behalf of the signed-in user.", - "displayName": "Read user's online meetings", - "id": "9be106e1-f4e3-4df5-bdff-e4bc531cbe43", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read online meeting details on your behalf.", - "userConsentDisplayName": "Read your online meetings", - "value": "OnlineMeetings.Read" - }, - { - "description": "Allows the app to read and create online meetings on behalf of the signed-in user.", - "displayName": "Read and create user's online meetings", - "id": "a65f2972-a4f8-4f5e-afd7-69ccb046d5dc", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and create online meetings on your behalf.", - "userConsentDisplayName": "Read and create your online meetings", - "value": "OnlineMeetings.ReadWrite" - }, - { - "description": "Allows the app to read the signed-in user's teamwork activity feed.", - "displayName": "Read user's teamwork activity feed", - "id": "0e755559-83fb-4b44-91d0-4cc721b9323e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your teamwork activity feed.", - "userConsentDisplayName": "Read your teamwork activity feed", - "value": "TeamsActivity.Read" - }, - { - "description": "Allows the app to request and manage time-based assignment and just-in-time elevation of user privileges to manage Azure resources (like subscriptions, resource groups, storage, compute) on behalf of the signed-in users.", - "displayName": "Read and write privileged access to Azure resources", - "id": "a84a9652-ffd3-496e-a991-22ba5529156a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to request and manage time-based assignment and just-in-time elevation of user privileges to manage \u00a0your Azure resources (like your subscriptions, resource groups, storage, compute) on your behalf.", - "userConsentDisplayName": "Read and write privileged access to Azure resources", - "value": "PrivilegedAccess.ReadWrite.AzureResources" - }, - { - "description": "Allows the app to read time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD built-in and custom administrative roles, on behalf of the signed-in user.", - "displayName": "Read privileged access to Azure AD", - "id": "b3a539c9-59cb-4ad5-825a-041ddbdc2bdb", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD built-in and custom administrative roles, on your behalf.", - "userConsentDisplayName": "Read privileged access to Azure AD", - "value": "PrivilegedAccess.Read.AzureAD" - }, - { - "description": "Allows the app to read time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD groups, on behalf of the signed-in user.", - "displayName": "Read privileged access to Azure AD groups", - "id": "d329c81c-20ad-4772-abf9-3f6fdb7e5988", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD groups, on your behalf.", - "userConsentDisplayName": "Read privileged access to Azure AD groups", - "value": "PrivilegedAccess.Read.AzureADGroup" - }, - { - "description": "Allows the app to read time-based assignment and just-in-time elevation of Azure resources (like your subscriptions, resource groups, storage, compute) on behalf of the signed-in user.", - "displayName": "Read privileged access to Azure resources", - "id": "1d89d70c-dcac-4248-b214-903c457af83a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read time-based assignment and just-in-time elevation of Azure resources (like your subscriptions, resource groups, storage, compute) on your behalf.", - "userConsentDisplayName": "Read privileged access to your Azure resources", - "value": "PrivilegedAccess.Read.AzureResources" - }, - { - "description": "Allows the app to request and manage time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD groups, on behalf of the signed-in user.", - "displayName": "Read and write privileged access to Azure AD groups", - "id": "32531c59-1f32-461f-b8df-6f8a3b89f73b", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to request and manage time-based assignment and just-in-time elevation (including scheduled elevation) of Azure AD groups, on your behalf.", - "userConsentDisplayName": "Read and write privileged access to Azure AD groups", - "value": "PrivilegedAccess.ReadWrite.AzureADGroup" - }, - { - "description": "Allows the app to read all the indicators for your organization, on behalf of the signed-in user.", - "displayName": "Read all threat indicators", - "id": "9cc427b4-2004-41c5-aa22-757b755e9796", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all the indicators for your organization, on your behalf.", - "userConsentDisplayName": "Read all threat indicators", - "value": "ThreatIndicators.Read.All" - }, - { - "description": "Allow the app to read external datasets and content, on behalf of the signed-in user.", - "displayName": "Read items in external datasets", - "id": "922f9392-b1b7-483c-a4be-0089be7704fb", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read external datasets and content that you have access to.", - "userConsentDisplayName": "Read items in external datasets", - "value": "ExternalItem.Read.All" - }, - { - "description": "Allows an app to edit channel messages in Microsoft Teams, on behalf of the signed-in user.", - "displayName": "Edit user's channel messages", - "id": "2b61aa8a-6d36-4b2f-ac7b-f29867937c53", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to edit channel messages in Microsoft Teams, on your behalf.", - "userConsentDisplayName": "Edit your channel messages", - "value": "ChannelMessage.Edit" - }, - { - "description": "Allows an app to send channel messages in Microsoft Teams, on behalf of the signed-in user.", - "displayName": "Send channel messages", - "id": "ebf0f66e-9fb1-49e4-a278-222f76911cf4", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to send channel messages in Microsoft Teams, on your behalf.", - "userConsentDisplayName": "Send channel messages", - "value": "ChannelMessage.Send" - }, - { - "description": "Allows the app to manage organization places (conference rooms and room lists) for calendar events and other applications, on behalf of the signed-in user.", - "displayName": "Read and write organization places", - "id": "4c06a06a-098a-4063-868e-5dfee3827264", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage organization places (conference rooms and room lists) for calendar events and other applications, on your behalf.", - "userConsentDisplayName": "Read and write organization places", - "value": "Place.ReadWrite.All" - }, - { - "description": "Allows the app to request access to and management of access packages and related entitlement management resources on behalf of the signed-in user.", - "displayName": "Read and write entitlement management resources", - "id": "ae7a573d-81d7-432b-ad44-4ed5c9d89038", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to request access to and management of access packages and related entitlement management resources that you have access to.", - "userConsentDisplayName": "Read and write entitlement management resources", - "value": "EntitlementManagement.ReadWrite.All" - }, - { - "description": "Allows the app to send, read, update and delete user\u2019s notifications.", - "displayName": "Deliver and manage user's notifications", - "id": "26e2f3e8-b2a1-47fc-9620-89bb5b042024", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to send, read, update and delete your app-specific notifications.", - "userConsentDisplayName": "Deliver and manage your notifications", - "value": "UserNotification.ReadWrite.CreatedByApp" - }, - { - "description": "Allows the app to read applications and service principals on behalf of the signed-in user.", - "displayName": "Read applications", - "id": "c79f8feb-a9db-4090-85f9-90d820caa0eb", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read applications and service principals on your behalf.", - "userConsentDisplayName": "Read applications", - "value": "Application.Read.All" - }, - { - "description": "Allows the app to create, read, update and delete applications and service principals on behalf of the signed-in user. Does not allow management of consent grants.", - "displayName": "Read and write all applications", - "id": "bdfbf15f-ee85-4955-8675-146e8e5296b5", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create, read, update and delete applications and service principals on your behalf. Does not allow management of consent grants.", - "userConsentDisplayName": "Read and write applications", - "value": "Application.ReadWrite.All" - }, - { - "description": "Allows the app to read BitLocker keys on behalf of the signed-in user, for their owned devices. Allows read of the recovery key.", - "displayName": "Read BitLocker keys", - "id": "b27a61ec-b99c-4d6a-b126-c4375d08ae30", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read BitLocker keys for your owned devices. Allows read of the recovery key.", - "userConsentDisplayName": "Read your BitLocker keys", - "value": "BitlockerKey.Read.All" - }, - { - "description": "Allows the app to read basic BitLocker key properties on behalf of the signed-in user, for their owned devices. Does not allow read of the recovery key itself.", - "displayName": "Read BitLocker keys basic information", - "id": "5a107bfc-4f00-4e1a-b67e-66451267bc68", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read basic BitLocker key properties for your owned devices. Does not allow read of the recovery key itself.", - "userConsentDisplayName": "Read your BitLocker keys basic information", - "value": "BitlockerKey.ReadBasic.All" - }, - { - "description": "Allows the app to list groups, read basic group properties and read membership of all groups the signed-in user has access to.", - "displayName": "Read group memberships", - "id": "bc024368-1153-4739-b217-4326f2e966d0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to list groups, read basic group properties and read membership of all your groups.", - "userConsentDisplayName": "Read group memberships", - "value": "GroupMember.Read.All" - }, - { - "description": "Allows the app to list groups, read basic properties, read and update the membership of the groups the signed-in user has access to. Group properties and owners cannot be updated and groups cannot be deleted.", - "displayName": "Read and write group memberships", - "id": "f81125ac-d3b7-4573-a3b2-7099cc39df9e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to list groups, read basic properties, read and update the membership of your groups. Group properties and owners cannot be updated and groups cannot be deleted.", - "userConsentDisplayName": "Read and write group memberships", - "value": "GroupMember.ReadWrite.All" - }, - { - "description": "Allows an app to read your organization's threat assessment requests on behalf of the signed-in user. Also allows the app to create new requests to assess threats received by your organization on behalf of the signed-in user.", - "displayName": "Read and write threat assessment requests", - "id": "cac97e40-6730-457d-ad8d-4852fddab7ad", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read your organization's threat assessment requests on your behalf. Also allows the app to create new requests to assess threats received by your organization on your behalf.", - "userConsentDisplayName": "Read and write threat assessment requests", - "value": "ThreatAssessment.ReadWrite.All" - }, - { - "description": "Allows the app to read schedule, schedule groups, shifts and associated entities in the Teams or Shifts application on behalf of the signed-in user.", - "displayName": "Read user schedule items", - "id": "fccf6dd8-5706-49fa-811f-69e2e1b585d0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read schedule, schedule groups, shifts and associated entities in the Teams or Shifts application on your behalf.", - "userConsentDisplayName": "Read your schedule items", - "value": "Schedule.Read.All" - }, - { - "description": "Allows the app to manage schedule, schedule groups, shifts and associated entities in the Teams or Shifts application on behalf of the signed-in user.", - "displayName": "Read and write user schedule items", - "id": "63f27281-c9d9-4f29-94dd-6942f7f1feb0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage schedule, schedule groups, shifts and associated entities in the Teams or Shifts application on your behalf.", - "userConsentDisplayName": "Read and write your schedule items", - "value": "Schedule.ReadWrite.All" - }, - { - "description": " Allows the app to read and write authentication methods of all users in your organization that the signed-in user has access to. Authentication methods include things like a user\u2019s phone numbers and Authenticator app settings. This does not allow the app to see secret information like passwords, or to sign-in or otherwise use the authentication methods.", - "displayName": "Read and write all users' authentication methods.", - "id": "b7887744-6746-4312-813d-72daeaee7e2d", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write authentication methods of all users you have access to in your organization. Authentication methods include things like a user\u2019s phone numbers and Authenticator app settings. This does not allow the app to see secret information like passwords, or to sign-in or otherwise use the authentication methods.", - "userConsentDisplayName": "Read and write all users' authentication methods", - "value": "UserAuthenticationMethod.ReadWrite.All" - }, - { - "description": "Allows the app to read and write the signed-in user's authentication methods, including phone numbers and Authenticator app settings. This does not allow the app to see secret information like the signed-in user's passwords, or to sign-in or otherwise use the signed-in user's authentication methods. ", - "displayName": "Read and write user authentication methods", - "id": "48971fc1-70d7-4245-af77-0beb29b53ee2", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your authentication methods, including phone numbers and Authenticator app settings.This does not allow the app to see secret information like your passwords, or to sign-in or otherwise use your authentication methods.", - "userConsentDisplayName": "Read and write your authentication methods", - "value": "UserAuthenticationMethod.ReadWrite" - }, - { - "description": "Allows the app to read authentication methods of all users in your organization that the signed-in user has access to. Authentication methods include things like a user\u2019s phone numbers and Authenticator app settings. This does not allow the app to see secret information like passwords, or to sign-in or otherwise use the authentication methods.", - "displayName": "Read all users' authentication methods", - "id": "aec28ec7-4d02-4e8c-b864-50163aea77eb", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read authentication methods of all users you have access to in your organization. Authentication methods include things like a user\u2019s phone numbers and Authenticator app settings. This does not allow the app to see secret information like passwords, or to sign-in or otherwise use the authentication methods.", - "userConsentDisplayName": "Read all users' authentication methods", - "value": "UserAuthenticationMethod.Read.All" - }, - { - "description": "Allows the app to read the signed-in user's authentication methods, including phone numbers and Authenticator app settings. This does not allow the app to see secret information like the signed-in user's passwords, or to sign-in or otherwise use the signed-in user's authentication methods.", - "displayName": "Read user authentication methods.", - "id": "1f6b61c5-2f65-4135-9c9f-31c0f8d32b52", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your authentication methods, including phone numbers and Authenticator app settings. This does not allow the app to see secret information like your passwords, or to sign-in or otherwise use your authentication methods.", - "userConsentDisplayName": "Read your authentication methods.", - "value": "UserAuthenticationMethod.Read" - }, - { - "description": "Allows the app to create tabs in any team in Microsoft Teams, on behalf of the signed-in user. This does not grant the ability to read, modify or delete tabs after they are created, or give access to the content inside the tabs.", - "displayName": "Create tabs in Microsoft Teams.", - "id": "a9ff19c2-f369-4a95-9a25-ba9d460efc8e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create tabs in any team in Microsoft Teams, on your behalf. This does not grant the ability to read, modify or delete tabs after they are created, or give access to the content inside the tabs.", - "userConsentDisplayName": "Create tabs in Microsoft Teams.", - "value": "TeamsTab.Create" - }, - { - "description": "Read the names and settings of tabs inside any team in Microsoft Teams, on behalf of the signed-in user. This does not give access to the content inside the tabs.", - "displayName": "Read tabs in Microsoft Teams.", - "id": "59dacb05-e88d-4c13-a684-59f1afc8cc98", - "Origin": "Delegated", - "userConsentDescription": "Read the names and settings of tabs inside any team in Microsoft Teams, on your behalf. This does not give access to the content inside the tabs.", - "userConsentDisplayName": "Read tabs in Microsoft Teams.", - "value": "TeamsTab.Read.All" - }, - { - "description": "Read and write tabs in any team in Microsoft Teams, on behalf of the signed-in user. This does not give access to the content inside the tabs.", - "displayName": "Read and write tabs in Microsoft Teams.", - "id": "b98bfd41-87c6-45cc-b104-e2de4f0dafb9", - "Origin": "Delegated", - "userConsentDescription": "Read and write tabs in any team in Microsoft Teams, on your behalf. This does not give access to the content inside the tabs.", - "userConsentDisplayName": "Read and write tabs in Microsoft Teams.", - "value": "TeamsTab.ReadWrite.All" - }, - { - "description": "Allows the app to have the same access to mailboxes as the signed-in user via IMAP protocol.", - "displayName": "Read and write access to mailboxes via IMAP.", - "id": "652390e4-393a-48de-9484-05f9b1212954", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create and delete email in your mailbox. Does not include permission to send mail.", - "userConsentDisplayName": "Read and write access to your mail.", - "value": "IMAP.AccessAsUser.All" - }, - { - "description": "Allows the app to have the same access to mailboxes as the signed-in user via POP protocol.", - "displayName": "Read and write access to mailboxes via POP.", - "id": "d7b7f2d9-0f45-4ea1-9d42-e50810c06991", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update, create and delete email in your mailbox. Does not include permission to send mail.", - "userConsentDisplayName": "Read and write access to your mail.", - "value": "POP.AccessAsUser.All" - }, - { - "description": "Allows the app to be able to send emails from the user\u2019s mailbox using the SMTP AUTH client submission protocol.", - "displayName": "Send emails from mailboxes using SMTP AUTH.", - "id": "258f6531-6087-4cc4-bb90-092c5fb3ed3f", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to send emails on your behalf from your mailbox.", - "userConsentDisplayName": "Access to sending emails from your mailbox.", - "value": "SMTP.Send" - }, - { - "description": "Allows the app to read all domain properties on behalf of the signed-in user.", - "displayName": "Read domains.", - "id": "2f9ee017-59c1-4f1d-9472-bd5529a7b311", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all domain properties on your behalf.", - "userConsentDisplayName": "Read domains.", - "value": "Domain.Read.All" - }, - { - "description": "Allows the app to read and write all domain properties on behalf of the signed-in user. Also allows the app to add, verify and remove domains.", - "displayName": "Read and write domains", - "id": "0b5d694c-a244-4bde-86e6-eb5cd07730fe", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write all domain properties on your behalf. Also allows the app to add, verify and remove domains.", - "userConsentDisplayName": "Read and write domains", - "value": "Domain.ReadWrite.All" - }, - { - "description": "Allows the app to read and write your organization's application configuration policies on behalf of the signed-in user. This includes policies such as activityBasedTimeoutPolicy, claimsMappingPolicy, homeRealmDiscoveryPolicy, tokenIssuancePolicy and tokenLifetimePolicy.", - "displayName": "Read and write your organization's application configuration policies", - "id": "b27add92-efb2-4f16-84f5-8108ba77985c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's application configuration policies on your behalf. This includes policies such as activityBasedTimeoutPolicy, claimsMappingPolicy, homeRealmDiscoveryPolicy, tokenIssuancePolicy and tokenLifetimePolicy.", - "userConsentDisplayName": "Read and write your organization's application configuration policies", - "value": "Policy.ReadWrite.ApplicationConfiguration" - }, - { - "description": "Allows the app to read your organization's devices' configuration information on behalf of the signed-in user.", - "displayName": "Read all devices", - "id": "951183d1-1a61-466f-a6d1-1fde911bfd95", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read devices' configuration information on your behalf.", - "userConsentDisplayName": "Read all devices", - "value": "Device.Read.All" - }, - { - "description": "Allows the app to read, update and delete identities that are associated with a user's account that the signed-in user has access to. This controls the identities users can sign-in with.", - "displayName": "Manage user identities", - "id": "637d7bec-b31e-4deb-acc9-24275642a2c9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, update and delete identities that are associated with a user's account that you have access to. This controls the identities users can sign-in with.", - "userConsentDisplayName": "Manage user identities", - "value": "User.ManageIdentities.All" - }, - { - "description": "Allows the app to read access packages and related entitlement management resources on behalf of the signed-in user.", - "displayName": "Read all entitlement management resources", - "id": "5449aa12-1393-4ea2-a7c7-d0e06c1a56b2", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read access packages and related entitlement management resources that you have access to.", - "userConsentDisplayName": "Read all entitlement management resources", - "value": "EntitlementManagement.Read.All" - }, - { - "description": "Create channels in any team, on behalf of the signed-in user.", - "displayName": "Create channels", - "id": "101147cf-4178-4455-9d58-02b5c164e759", - "Origin": "Delegated", - "userConsentDescription": "Create channels in any team, on your behalf.", - "userConsentDisplayName": "Create channels", - "value": "Channel.Create" - }, - { - "description": "Delete channels in any team, on behalf of the signed-in user.", - "displayName": "Delete channels", - "id": "cc83893a-e232-4723-b5af-bd0b01bcfe65", - "Origin": "Delegated", - "userConsentDescription": "Delete channels in any team, on your behalf.", - "userConsentDisplayName": "Delete channels", - "value": "Channel.Delete.All" - }, - { - "description": "Read all channel names, channel descriptions, and channel settings, on behalf of the signed-in user.", - "displayName": "Read the names, descriptions, and settings of channels", - "id": "233e0cf1-dd62-48bc-b65b-b38fe87fcf8e", - "Origin": "Delegated", - "userConsentDescription": "Read all channel names, channel descriptions, and channel settings, on your behalf.", - "userConsentDisplayName": "Read the names, descriptions, and settings of channels", - "value": "ChannelSettings.Read.All" - }, - { - "description": "Read and write the names, descriptions, and settings of all channels, on behalf of the signed-in user.", - "displayName": "Read and write the names, descriptions, and settings of channels", - "id": "d649fb7c-72b4-4eec-b2b4-b15acf79e378", - "Origin": "Delegated", - "userConsentDescription": "Read and write the names, descriptions, and settings of all channels, on your behalf.", - "userConsentDisplayName": "Read and write the names, descriptions, and settings of channels", - "value": "ChannelSettings.ReadWrite.All" - }, - { - "description": "Allows the app to read all webhook subscriptions on behalf of the signed-in user.", - "displayName": "Read all webhook subscriptions ", - "id": "5f88184c-80bb-4d52-9ff2-757288b2e9b7", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all webhook subscriptions on your behalf.", - "userConsentDisplayName": "Read all webhook subscriptions ", - "value": "Subscription.Read.All" - }, - { - "description": "Read the names and descriptions of teams, on behalf of the signed-in user.", - "displayName": "Read the names and descriptions of teams", - "id": "485be79e-c497-4b35-9400-0e3fa7f2a5d4", - "Origin": "Delegated", - "userConsentDescription": "Read the names and descriptions of teams, on your behalf.", - "userConsentDisplayName": "Read the names and descriptions of teams", - "value": "Team.ReadBasic.All" - }, - { - "description": "Read channel names and channel descriptions, on behalf of the signed-in user.", - "displayName": "Read the names and descriptions of channels", - "id": "9d8982ae-4365-4f57-95e9-d6032a4c0b87", - "Origin": "Delegated", - "userConsentDescription": "Read channel names and channel descriptions, on your behalf.", - "userConsentDisplayName": "Read the names and descriptions of channels", - "value": "Channel.ReadBasic.All" - }, - { - "description": "Read all teams' settings, on behalf of the signed-in user.", - "displayName": "Read teams' settings", - "id": "48638b3c-ad68-4383-8ac4-e6880ee6ca57", - "Origin": "Delegated", - "userConsentDescription": "Read all teams' settings, on your behalf.", - "userConsentDisplayName": "Read teams' settings", - "value": "TeamSettings.Read.All" - }, - { - "description": "Read and change all teams' settings, on behalf of the signed-in user.", - "displayName": "Read and change teams' settings", - "id": "39d65650-9d3e-4223-80db-a335590d027e", - "Origin": "Delegated", - "userConsentDescription": "Read and change all teams' settings, on your behalf.", - "userConsentDisplayName": "Read and change teams' settings", - "value": "TeamSettings.ReadWrite.All" - }, - { - "description": "Read the members of teams, on behalf of the signed-in user.", - "displayName": "Read the members of teams", - "id": "2497278c-d82d-46a2-b1ce-39d4cdde5570", - "Origin": "Delegated", - "userConsentDescription": "Read the members of teams, on your behalf.", - "userConsentDisplayName": "Read the members of teams", - "value": "TeamMember.Read.All" - }, - { - "description": "Add and remove members from teams, on behalf of the signed-in user. Also allows changing a member's role, for example from owner to non-owner.", - "displayName": "Add and remove members from teams", - "id": "4a06efd2-f825-4e34-813e-82a57b03d1ee", - "Origin": "Delegated", - "userConsentDescription": "Add and remove members from teams, on your behalf. Also allows changing a member's role, for example from owner to non-owner.", - "userConsentDisplayName": "Add and remove members from teams and channels", - "value": "TeamMember.ReadWrite.All" - }, - { - "description": "Allows the app to read consent requests and approvals on behalf of the signed-in user.", - "displayName": "Read consent requests", - "id": "f3bfad56-966e-4590-a536-82ecf548ac1e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read consent requests and approvals, on your behalf.", - "userConsentDisplayName": "Read consent requests", - "value": "ConsentRequest.Read.All" - }, - { - "description": "Allows the app to read app consent requests and approvals, and deny or approve those requests on behalf of the signed-in user.", - "displayName": "Read and write consent requests", - "id": "497d9dfa-3bd1-481a-baab-90895e54568c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read app consent requests for your approval, and deny or approve those request on your behalf.", - "userConsentDisplayName": "Read and write consent requests", - "value": "ConsentRequest.ReadWrite.All" - }, - { - "description": "Allows the app to read and write your organization's consent requests policy on behalf of the signed-in user.", - "displayName": "Read and write consent request policy", - "id": "4d135e65-66b8-41a8-9f8b-081452c91774", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's consent request policy on your behalf.", - "userConsentDisplayName": "Read and write consent request policy", - "value": "Policy.ReadWrite.ConsentRequest" - }, - { - "description": "Allows the app to read presence information on behalf of the signed-in user. Presence information includes activity, availability, status note, calendar out-of-office message, timezone and location.", - "displayName": "Read user's presence information", - "id": "76bc735e-aecd-4a1d-8b4c-2b915deabb79", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your presence information on your behalf. Presence information includes activity, availability, status note, calendar out-of-office message, timezone and location.", - "userConsentDisplayName": "Read your presence information", - "value": "Presence.Read" - }, - { - "description": "Allows the app to read presence information of all users in the directory on behalf of the signed-in user. Presence information includes activity, availability, status note, calendar out-of-office message, timezone and location.", - "displayName": "Read presence information of all users in your organization", - "id": "9c7a330d-35b3-4aa1-963d-cb2b9f927841", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read presence information of all users in the directory on your behalf. Presence information includes activity, availability, status note, calendar out-of-office message, timezone and location.", - "userConsentDisplayName": "Read presence information of all users in your organization", - "value": "Presence.Read.All" - }, - { - "description": "Read the members of channels, on behalf of the signed-in user.", - "displayName": "Read the members of channels", - "id": "2eadaff8-0bce-4198-a6b9-2cfc35a30075", - "Origin": "Delegated", - "userConsentDescription": "Read the members of channels, on your behalf.", - "userConsentDisplayName": "Read the members of teams and channels", - "value": "ChannelMember.Read.All" - }, - { - "description": "Add and remove members from channels, on behalf of the signed-in user. Also allows changing a member's role, for example from owner to non-owner.", - "displayName": "Add and remove members from channels", - "id": "0c3e411a-ce45-4cd1-8f30-f99a3efa7b11", - "Origin": "Delegated", - "userConsentDescription": "Add and remove members from channels, on your behalf. Also allows changing a member's role, for example from owner to non-owner.", - "userConsentDisplayName": "Add and remove members from teams and channels", - "value": "ChannelMember.ReadWrite.All" - }, - { - "description": "Allows the app to read and write the authentication flow policies, on behalf of the signed-in user. ", - "displayName": "Read and write authentication flow policies", - "id": "edb72de9-4252-4d03-a925-451deef99db7", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the authentication flow policies for your tenant, on your behalf.", - "userConsentDisplayName": "Read and write your authentication flow policies", - "value": "Policy.ReadWrite.AuthenticationFlows" - }, - { - "description": "Allows an app to read a channel's messages in Microsoft Teams, on behalf of the signed-in user.", - "displayName": "Read user channel messages", - "id": "767156cb-16ae-4d10-8f8b-41b657c8c8c8", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read a channel's messages in Microsoft Teams, on your behalf.", - "userConsentDisplayName": "Read your channel messages", - "value": "ChannelMessage.Read.All" - }, - { - "description": "Allows the app to read the apps in the app catalogs.", - "displayName": "Read all app catalogs", - "id": "88e58d74-d3df-44f3-ad47-e89edf4472e4", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read apps in the app catalogs.", - "userConsentDisplayName": "Read all app catalogs", - "value": "AppCatalog.Read.All" - }, - { - "description": "Allows the app to read and write the authentication method policies, on behalf of the signed-in user.\u00a0", - "displayName": "Read and write authentication method policies", - "id": "7e823077-d88e-468f-a337-e18f1f0e6c7c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the authentication method policies for your tenant, on your behalf.", - "userConsentDisplayName": "Read and write your authentication method policies ", - "value": "Policy.ReadWrite.AuthenticationMethod" - }, - { - "description": "Allows the app to read and write your organization's authorization policy on behalf of the signed-in user. For example, authorization policies can control some of the permissions that the out-of-the-box user role has by default.", - "displayName": "Read and write your organization's authorization policy", - "id": "edd3c878-b384-41fd-95ad-e7407dd775be", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's authorization policy on your behalf. For example, authorization policies can control some of the permissions that the out-of-the-box user role has by default.", - "userConsentDisplayName": "Read and write your organization's authorization policy", - "value": "Policy.ReadWrite.Authorization" - }, - { - "description": "Allows the app to read policies related to consent and permission grants for applications, on behalf of the signed-in user.", - "displayName": "Read consent and permission grant policies", - "id": "414de6ea-2d92-462f-b120-6e2a809a6d01", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read policies related to consent and permission grants for applications, on your behalf.", - "userConsentDisplayName": "Read consent and permission grant policies", - "value": "Policy.Read.PermissionGrant" - }, - { - "description": "Allows the app to manage policies related to consent and permission grants for applications, on behalf of the signed-in user.", - "displayName": "Manage consent and permission grant policies", - "id": "2672f8bb-fd5e-42e0-85e1-ec764dd2614e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage policies related to consent and permission grants for applications, on behalf of the signed-in user.", - "userConsentDisplayName": "Manage consent and permission grant policies", - "value": "Policy.ReadWrite.PermissionGrant" - }, - { - "description": "Allows the application to create (register) printers on behalf of the signed-in user.\u00a0", - "displayName": "Register printers\u202f\u00a0", - "id": "90c30bed-6fd1-4279-bf39-714069619721", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to create (register) printers on your behalf.\u00a0", - "userConsentDisplayName": "Register printers\u202f\u00a0", - "value": "Printer.Create" - }, - { - "description": "Allows the application to create (register), read, update, and delete (unregister) printers on behalf of the signed-in user.\u00a0", - "displayName": "Register, read, update, and unregister printers", - "id": "93dae4bd-43a1-4a23-9a1a-92957e1d9121", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to create (register), read, update, and delete (unregister) printers on your behalf.\u00a0\u00a0", - "userConsentDisplayName": "Register, read, update, and unregister printers", - "value": "Printer.FullControl.All" - }, - { - "description": "Allows the application to read printers on behalf of the signed-in user.\u00a0", - "displayName": "Read printers", - "id": "3a736c8a-018e-460a-b60c-863b2683e8bf", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read printers on your behalf.\u00a0", - "userConsentDisplayName": "Read printers", - "value": "Printer.Read.All" - }, - { - "description": "Allows the application to read and update printers on behalf of the signed-in user.\u00a0Does not allow creating (registering) or deleting (unregistering) printers.", - "displayName": "Read and update printers", - "id": "89f66824-725f-4b8f-928e-e1c5258dc565", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read and update printers on your behalf.\u00a0Does not allow creating (registering) or deleting (unregistering) printers.", - "userConsentDisplayName": "Read and update printers", - "value": "Printer.ReadWrite.All" - }, - { - "description": "Allows the application to read printer shares on behalf of the signed-in user.\u00a0", - "displayName": "Read printer shares", - "id": "ed11134d-2f3f-440d-a2e1-411efada2502", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read printer shares on your behalf.\u00a0", - "userConsentDisplayName": "Read printer shares", - "value": "PrinterShare.Read.All" - }, - { - "description": "Allows the application to read and update printer shares on behalf of the signed-in user.\u00a0", - "displayName": "Read and write printer shares", - "id": "06ceea37-85e2-40d7-bec3-91337a46038f", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read and update printer shares on your behalf.\u00a0", - "userConsentDisplayName": "Read and update printer shares", - "value": "PrinterShare.ReadWrite.All" - }, - { - "description": "Allows the application to read the metadata and document content of print jobs that the signed-in user created.", - "displayName": "Read user's print jobs", - "id": "248f5528-65c0-4c88-8326-876c7236df5e", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read the metadata and document content of print jobs that you created.", - "userConsentDisplayName": "Read your print jobs", - "value": "PrintJob.Read" - }, - { - "description": "Allows the application to read the metadata and document content of print jobs on behalf of the signed-in user.\u00a0", - "displayName": "Read print jobs", - "id": "afdd6933-a0d8-40f7-bd1a-b5d778e8624b", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read the metadata and document content of print jobs on your behalf.\u00a0", - "userConsentDisplayName": "Read print jobs", - "value": "PrintJob.Read.All" - }, - { - "description": "Allows the application to read the metadata of print jobs that the signed-in user created. Does not allow access to print job document content.", - "displayName": "Read basic information of user's print jobs", - "id": "6a71a747-280f-4670-9ca0-a9cbf882b274", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read the metadata of print jobs that you created. Does not allow access to print job document content.", - "userConsentDisplayName": "Read basic information of your print jobs", - "value": "PrintJob.ReadBasic" - }, - { - "description": "Allows the application to read the metadata of print jobs on behalf of the signed-in user.\u00a0Does not allow access to print job document content.", - "displayName": "Read basic information of print jobs", - "id": "04ce8d60-72ce-4867-85cf-6d82f36922f3", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read the metadata of print jobs on your behalf.\u00a0Does not allow access to print job document content.", - "userConsentDisplayName": "Read basic information of print jobs", - "value": "PrintJob.ReadBasic.All" - }, - { - "description": "Allows the application to read and update the metadata and document content of print jobs that the signed-in user created.", - "displayName": "Read and write user's print jobs", - "id": "b81dd597-8abb-4b3f-a07a-820b0316ed04", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read and update the metadata and document content of print jobs that you created.", - "userConsentDisplayName": "Read and update your print jobs", - "value": "PrintJob.ReadWrite" - }, - { - "description": "Allows the application to read and update the metadata and document content of print jobs on behalf of the signed-in user.\u00a0", - "displayName": "Read and write print jobs", - "id": "036b9544-e8c5-46ef-900a-0646cc42b271", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read and update the metadata and document content of print jobs on your behalf.\u00a0", - "userConsentDisplayName": "Read and update print jobs", - "value": "PrintJob.ReadWrite.All" - }, - { - "description": "Allows the application to read and update the metadata of print jobs that the signed-in user created. Does not allow access to print job document content.", - "displayName": "Read and write basic information of user's print jobs", - "id": "6f2d22f2-1cb6-412c-a17c-3336817eaa82", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read and update the metadata of print jobs that you created. Does not allow access to print job document content.", - "userConsentDisplayName": "Read and write basic information of your print jobs", - "value": "PrintJob.ReadWriteBasic" - }, - { - "description": "Allows the application to read and update the metadata of print jobs on behalf of the signed-in user.\u00a0Does not allow access to print job document content.", - "displayName": "Read and write basic information of print jobs", - "id": "3a0db2f6-0d2a-4c19-971b-49109b19ad3d", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read and update the metadata of print jobs on your behalf.\u00a0Does not allow access to print job document content.", - "userConsentDisplayName": "Read and write basic information of print jobs", - "value": "PrintJob.ReadWriteBasic.All" - }, - { - "description": "Allows the app to read and write your organization's device configuration policies on behalf of the signed-in user. For example, device registration policy can limit initial provisioning controls using quota restrictions, additional authentication and authorization checks.", - "displayName": "Read and write your organization's device configuration policies", - "id": "40b534c3-9552-4550-901b-23879c90bcf9", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write your organization's device configuration policies on your behalf. For example, device registration policy can limit initial provisioning controls using quota restrictions, additional authentication and authorization checks.", - "userConsentDisplayName": "Read and write your organization's device configuration policies", - "value": "Policy.ReadWrite.DeviceConfiguration" - }, - { - "description": "Allows the app to submit application packages to the catalog and cancel submissions that are pending review on behalf of the signed-in user.", - "displayName": "Submit application packages to the catalog and cancel pending submissions", - "id": "3db89e36-7fa6-4012-b281-85f3d9d9fd2e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to submit application packages to the catalog and cancel submissions that are pending review on your behalf.", - "userConsentDisplayName": "Submit application packages to your organization's catalog and cancel pending submissions", - "value": "AppCatalog.Submit" - }, - { - "description": "Allows the app to read the Teams apps that are installed in chats the signed-in user can access. Does not give the ability to read application-specific settings.", - "displayName": "Read installed Teams apps in chats", - "id": "bf3fbf03-f35f-4e93-963e-47e4d874c37a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the Teams apps that are installed in chats that you can access. Does not give the ability to read application-specific settings.", - "userConsentDisplayName": "Read installed Teams apps in chats", - "value": "TeamsAppInstallation.ReadForChat" - }, - { - "description": "Allows the app to read the Teams apps that are installed in teams the signed-in user can access. Does not give the ability to read application-specific settings.", - "displayName": "Read installed Teams apps in teams", - "id": "5248dcb1-f83b-4ec3-9f4d-a4428a961a72", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the Teams apps that are installed in teams that you can access. Does not give the ability to read application-specific settings.", - "userConsentDisplayName": "Read installed Teams apps in teams", - "value": "TeamsAppInstallation.ReadForTeam" - }, - { - "description": "Allows the app to read the Teams apps that are installed for the signed-in user. Does not give the ability to read application-specific settings.", - "displayName": "Read user's installed Teams apps", - "id": "c395395c-ff9a-4dba-bc1f-8372ba9dca84", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the Teams apps that are installed for you. Does not give the ability to read application-specific settings.", - "userConsentDisplayName": "Read your installed Teams apps", - "value": "TeamsAppInstallation.ReadForUser" - }, - { - "description": "Allows the app to read, install, upgrade, and uninstall Teams apps in teams the signed-in user can access. Does not give the ability to read application-specific settings.", - "displayName": "Manage installed Teams apps in teams", - "id": "2e25a044-2580-450d-8859-42eeb6e996c0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, install, upgrade, and uninstall Teams apps in teams you can access. Does not give the ability to read application-specific settings.", - "userConsentDisplayName": "Manage installed Teams apps in teams", - "value": "TeamsAppInstallation.ReadWriteForTeam" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall itself in chats the signed-in user can access.", - "displayName": "Allow the Teams app to manage itself in chats", - "id": "0ce33576-30e8-43b7-99e5-62f8569a4002", - "Origin": "Delegated", - "userConsentDescription": "Allows a Teams app to read, install, upgrade, and uninstall itself in chats you can access.", - "userConsentDisplayName": "Allow the Teams app to manage itself in chats", - "value": "TeamsAppInstallation.ReadWriteSelfForChat" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall itself for the signed-in user.", - "displayName": "Allow the Teams app to manage itself for a user", - "id": "207e0cb1-3ce7-4922-b991-5a760c346ebc", - "Origin": "Delegated", - "userConsentDescription": "Allows a Teams app to read, install, upgrade, and uninstall itself for you.", - "userConsentDisplayName": "Allow the Teams app to manage itself for you", - "value": "TeamsAppInstallation.ReadWriteSelfForUser" - }, - { - "description": "Allows the app to read, install, upgrade, and uninstall Teams apps installed for the signed-in user. Does not give the ability to read application-specific settings.", - "displayName": "Manage user's installed Teams apps", - "id": "093f8818-d05f-49b8-95bc-9d2a73e9a43c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, install, upgrade, and uninstall Teams apps installed for you. Does not give the ability to read application-specific settings.", - "userConsentDisplayName": "Manage your installed Teams apps", - "value": "TeamsAppInstallation.ReadWriteForUser" - }, - { - "description": "Allows the app to create teams on behalf of the signed-in user.", - "displayName": "Create teams", - "id": "7825d5d6-6049-4ce7-bdf6-3b8d53f4bcd0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create teams on your behalf.\u00a0", - "userConsentDisplayName": "Create teams", - "value": "Team.Create" - }, - { - "description": "Add and remove members from all teams, on behalf of the signed-in user. Does not allow adding or removing a member with the owner role. Additionally, does not allow the app to elevate an existing member to the owner role.", - "displayName": "Add and remove members with non-owner role for all teams", - "id": "2104a4db-3a2f-4ea0-9dba-143d457dc666", - "Origin": "Delegated", - "userConsentDescription": "Add and remove members from all teams, on your behalf. Does not allow adding or removing a member with the owner role. Additionally, does not allow the app to elevate an existing member to the owner role.", - "userConsentDisplayName": "Add and remove members with non-owner role for all teams", - "value": "TeamMember.ReadWriteNonOwnerRole.All" - }, - { - "description": "Allows the app to read the term store data that the signed-in user has access to. This includes all sets, groups and terms in the term store.", - "displayName": "Read term store data", - "id": "297f747b-0005-475b-8fef-c890f5152b38", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the term store data that you have access to. This includes all sets, groups and terms in the term store.", - "userConsentDisplayName": "Read term store data", - "value": "TermStore.Read.All" - }, - { - "description": "Allows the app to read or modify data that the signed-in user has access to.\u00a0This includes all sets, groups and terms in the term store.", - "displayName": "Read and write term store data", - "id": "6c37c71d-f50f-4bff-8fd3-8a41da390140", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read or modify data that you have access to. This includes all sets, groups and terms in the term store.", - "userConsentDisplayName": "Read and write term store data", - "value": "TermStore.ReadWrite.All" - }, - { - "description": "Allows the app to read your tenant's service announcement messages on behalf of the signed-in user. Messages may include information about new or changed features.", - "displayName": "Read service announcement messages", - "id": "eda39fa6-f8cf-4c3c-a909-432c683e4c9b", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your tenant's service announcement messages on your behalf. Messages may include information about new or changed features.", - "userConsentDisplayName": "Read service messages", - "value": "ServiceMessage.Read.All" - }, - { - "description": "Allows the app to read your tenant's service health information on behalf of the signed-in user. Health information may include service issues or service health overviews.", - "displayName": "Read service health", - "id": "55896846-df78-47a7-aa94-8d3d4442ca7f", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your tenant's service health information on your behalf.Health information may include service issues or service health overviews.", - "userConsentDisplayName": "Read service health", - "value": "ServiceHealth.Read.All" - }, - { - "description": "Allows the app to read all the short notes a sign-in user has access to.", - "displayName": "Read short notes of the signed-in user", - "id": "50f66e47-eb56-45b7-aaa2-75057d9afe08", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your short notes.", - "userConsentDisplayName": "Read your short notes", - "value": "ShortNotes.Read" - }, - { - "description": "Allows the app to read, create, edit, and delete short notes of a signed-in user.", - "displayName": "Read, create, edit, and delete short notes of the signed-in user", - "id": "328438b7-4c01-4c07-a840-e625a749bb89", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, create, edit, and delete your short notes.", - "userConsentDisplayName": "Read, create, edit, and delete your short notes", - "value": "ShortNotes.ReadWrite" - }, - { - "description": "Allows the app to read your organization's conditional access policies on behalf of the signed-in user.", - "displayName": "Read your organization's conditional access policies", - "id": "633e0fce-8c58-4cfb-9495-12bbd5a24f7c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization's conditional access policies on your behalf.", - "userConsentDisplayName": "Read your organization's conditional access policies", - "value": "Policy.Read.ConditionalAccess" - }, - { - "description": "Allows the app to read the role-based access control (RBAC) settings for all RBAC providers, on behalf of the signed-in user. This includes reading role definitions and role assignments.", - "displayName": "Read role management data for all RBAC providers", - "id": "48fec646-b2ba-4019-8681-8eb31435aded", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the role-based access control (RBAC) settings for all RBAC providers, on your behalf. This includes reading role definitions and role assignments.", - "userConsentDisplayName": "Read role management data for all RBAC providers", - "value": "RoleManagement.Read.All" - }, - { - "description": "Allows an app to send one-to-one and group chat messages in Microsoft Teams, on behalf of the signed-in user.", - "displayName": "Send user chat messages", - "id": "116b7235-7cc6-461e-b163-8e55691d839e", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to send one-to-one and group chat messages in Microsoft Teams, on your behalf.", - "userConsentDisplayName": "Send chat messages", - "value": "ChatMessage.Send" - }, - { - "description": "Allows an app to read the members and descriptions of one-to-one and group chat threads, on behalf of the signed-in user.", - "displayName": "Read names and members of user chat threads", - "id": "9547fcb5-d03f-419d-9948-5928bbf71b0f", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read the members and descriptions of one-to-one and group chat threads, on your behalf.", - "userConsentDisplayName": "Read names and members of your chat threads", - "value": "Chat.ReadBasic" - }, - { - "description": "Allows the app to read and write the properties of Cloud PCs on behalf of the signed-in user.", - "displayName": "Read and write Cloud PCs", - "id": "9d77138f-f0e2-47ba-ab33-cd246c8b79d1", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the properties of Cloud PCs, on your behalf.", - "userConsentDisplayName": "Read and write Cloud PCs", - "value": "CloudPC.ReadWrite.All" - }, - { - "description": "Allows the app to read the properties of Cloud PCs on behalf of the signed-in user.", - "displayName": "Read Cloud PCs", - "id": "5252ec4e-fd40-4d92-8c68-89dd1d3c6110", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the properties of Cloud PCs, on your behalf.", - "userConsentDisplayName": "Read Cloud PCs", - "value": "CloudPC.Read.All" - }, - { - "description": "Allows the app to read, install, upgrade, and uninstall Teams apps in chats the signed-in user can access. Does not give the ability to read application-specific settings.", - "displayName": "Manage installed Teams apps in chats", - "id": "aa85bf13-d771-4d5d-a9e6-bca04ce44edf", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, install, upgrade, and uninstall Teams apps in chats you can access. Does not give the ability to read application-specific settings.", - "userConsentDisplayName": "Manage installed Teams apps in chats", - "value": "TeamsAppInstallation.ReadWriteForChat" - }, - { - "description": "Allows the app to create, read, update, and delete the signed-in user's tasks and task lists, including any shared with the user.", - "displayName": "Create, read, update, and delete user\u2019s tasks and task lists", - "id": "2219042f-cab5-40cc-b0d2-16b1540b4c5f", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create, read, update, and delete your tasks and task lists, including any shared with you.", - "userConsentDisplayName": "Create, read, update, and delete your tasks and task lists", - "value": "Tasks.ReadWrite" - }, - { - "description": "Allows the app to read the signed-in user\u2019s tasks and task lists, including any shared with the user. Doesn't include permission to create, delete, or update anything.", - "displayName": "Read user's tasks and task lists", - "id": "f45671fb-e0fe-4b4b-be20-3d3ce43f1bcb", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your tasks and task lists, including any shared with you. Doesn't include permission to create, delete, or update anything.", - "userConsentDisplayName": "Read your tasks and task lists", - "value": "Tasks.Read" - }, - { - "description": "Allows an app to read one-to-one and group chat messages, on behalf of the signed-in user.", - "displayName": "Read user chat messages", - "id": "cdcdac3a-fd45-410d-83ef-554db620e5c7", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read one-to-one or group chat messages in Microsoft Teams, on your behalf.", - "userConsentDisplayName": "Read user chat messages", - "value": "ChatMessage.Read" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall all tabs in chats the signed-in user can access.", - "displayName": "Allow the Teams app to manage all tabs in chats", - "id": "ee928332-e9c2-4747-b4a0-f8c164b68de6", - "Origin": "Delegated", - "userConsentDescription": "Allows a Teams app to read, install, upgrade, and uninstall all tabs in chats you can access.", - "userConsentDisplayName": "Allow the Teams app to manage all tabs in chats", - "value": "TeamsTab.ReadWriteForChat" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall all tabs to teams the signed-in user can access.", - "displayName": "Allow the Teams app to manage all tabs in teams", - "id": "c975dd04-a06e-4fbb-9704-62daad77bb49", - "Origin": "Delegated", - "userConsentDescription": "Allows a Teams app to read, install, upgrade, and uninstall all tabs to teams you can access.", - "userConsentDisplayName": "Allow the app to manage all tabs in teams", - "value": "TeamsTab.ReadWriteForTeam" - }, - { - "description": "Allows a Teams app to read, install, upgrade, and uninstall all tabs for the signed-in user.", - "displayName": "Allow the Teams app to manage all tabs for a user", - "id": "c37c9b61-7762-4bff-a156-afc0005847a0", - "Origin": "Delegated", - "userConsentDescription": "Allows a Teams app to read, install, upgrade, and uninstall all tabs for you.", - "userConsentDisplayName": "Allow the Teams app to manage all tabs for you", - "value": "TeamsTab.ReadWriteForUser" - }, - { - "description": "Allows the app to read the API connectors used in user authentication flows, on behalf of the signed-in user.", - "displayName": "Read API connectors for authentication flows", - "id": "1b6ff35f-31df-4332-8571-d31ea5a4893f", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the API connectors used in user authentication flows, on your behalf.", - "userConsentDisplayName": "Read API connectors for authentication flows", - "value": "APIConnectors.Read.All" - }, - { - "description": "Allows the app to read, create and manage the API connectors used in user authentication flows, on behalf of the signed-in user.", - "displayName": "Read and write API connectors for authentication flows", - "id": "c67b52c5-7c69-48b6-9d48-7b3af3ded914", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read, create and manage the API connectors used in user authentication flows, on your behalf.", - "userConsentDisplayName": "Read and write API connectors for authentication flows", - "value": "APIConnectors.ReadWrite.All" - }, - { - "description": "Read the members of chats, on behalf of the signed-in user.", - "displayName": "Read the members of chats", - "id": "c5a9e2b1-faf6-41d4-8875-d381aa549b24", - "Origin": "Delegated", - "userConsentDescription": "Read the members of chats, on your behalf.", - "userConsentDisplayName": "Read the members of chats", - "value": "ChatMember.Read" - }, - { - "description": "Add and remove members from chats, on behalf of the signed-in user.", - "displayName": "Add and remove members from chats", - "id": "dea13482-7ea6-488f-8b98-eb5bbecf033d", - "Origin": "Delegated", - "userConsentDescription": "Add and remove members from chats, on your behalf.", - "userConsentDisplayName": "Add and remove members from chats", - "value": "ChatMember.ReadWrite" - }, - { - "description": "Allows the app to create chats on behalf of the signed-in user.", - "displayName": "Create chats", - "id": "38826093-1258-4dea-98f0-00003be2b8d0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create chats on your behalf.\u00a0", - "userConsentDisplayName": "Create chats", - "value": "Chat.Create" - }, - { - "description": "Allows the application to read and write tenant-wide print settings on behalf of the signed-in user.", - "displayName": "Read and write tenant-wide print settings", - "id": "9ccc526a-c51c-4e5c-a1fd-74726ef50b8f", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read and write tenant-wide print settings on your behalf.", - "userConsentDisplayName": "Read and write tenant-wide print settings", - "value": "PrintSettings.ReadWrite.All" - }, - { - "description": "Allows the application to read tenant-wide print settings on behalf of the signed-in user.", - "displayName": "Read tenant-wide print settings", - "id": "490f32fd-d90f-4dd7-a601-ff6cdc1a3f6c", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read tenant-wide print settings on your behalf.", - "userConsentDisplayName": "Read tenant-wide print settings", - "value": "PrintSettings.Read.All" - }, - { - "description": "Allows the application to read and write print connectors on behalf of the signed-in user. ", - "displayName": "Read and write print connectors", - "id": "79ef9967-7d59-4213-9c64-4b10687637d8", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read and write print connectors on your behalf.", - "userConsentDisplayName": "Read and write print connectors", - "value": "PrintConnector.ReadWrite.All" - }, - { - "description": "Allows the application to read print connectors on behalf of the signed-in user.", - "displayName": "Read print connectors", - "id": "d69c2d6d-4f72-4f99-a6b9-663e32f8cf68", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read print connectors on your behalf.", - "userConsentDisplayName": "Read print connectors", - "value": "PrintConnector.Read.All" - }, - { - "description": "Allows the application to read basic information about printer shares on behalf of the signed-in user. Does not allow reading access control information.", - "displayName": "Read basic information about printer shares", - "id": "5fa075e9-b951-4165-947b-c63396ff0a37", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read basic information about printer shares on your behalf.", - "userConsentDisplayName": "Read basic information about printer shares", - "value": "PrinterShare.ReadBasic.All" - }, - { - "description": "Allows the application to create print jobs on behalf of the signed-in user and upload document content to print jobs that the signed-in user created.", - "displayName": "Create print jobs", - "id": "21f0d9c0-9f13-48b3-94e0-b6b231c7d320", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to create print jobs on your behalf and upload document content to print jobs that you created.", - "userConsentDisplayName": "Create your print jobs", - "value": "PrintJob.Create" - }, - { - "description": "Allows the app to read Azure AD recommendations, on behalf of the signed-in user.", - "displayName": "Read Azure AD recommendations", - "id": "34d3bd24-f6a6-468c-b67c-0c365c1d6410", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read Azure AD recommendations, on your behalf.", - "userConsentDisplayName": "Read Azure AD recommendations", - "value": "DirectoryRecommendations.Read.All" - }, - { - "description": "Allows the application to list and query user profile information associated with the current tenant on behalf of the signed-in user.\u00a0 It also permits the application to export and remove external user data (e.g. customer content or system-generated logs), associated with the current tenant on behalf of the signed-in user.", - "displayName": "Read shared cross-tenant user profile and export or delete data", - "id": "eed0129d-dc60-4f30-8641-daf337a39ffd", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to list and query shared user profile information associated with the current tenant on your behalf.\u00a0 It also permits the application to export and remove your external user data (e.g. customer content or system-generated logs), associated with the current tenant on your behalf.", - "userConsentDisplayName": "Read shared cross-tenant user profile and export or delete data", - "value": "CrossTenantUserProfileSharing.ReadWrite" - }, - { - "description": "Allows the app to manage restricted resources based on the other permissions granted to the app, on behalf of the signed-in user.", - "displayName": "Manage restricted resources in the directory", - "id": "cba5390f-ed6a-4b7f-b657-0efc2210ed20", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage restricted resources based on the other permissions granted to the app, on your behalf.", - "userConsentDisplayName": "Manage restricted resources in the directory", - "value": "Directory.Write.Restricted" - }, - { - "description": "Allows the app to read your organization's threat submission policies on behalf of the signed-in user. Also allows the app to create new threat submission policies on behalf of the signed-in user.", - "displayName": "Read and write all threat submission policies", - "id": "059e5840-5353-4c68-b1da-666a033fc5e8", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization's threat submission policies on your behalf. Also allows the app to create new threat submission policies on your behalf.", - "userConsentDisplayName": "Read and write all threat submission policies", - "value": "ThreatSubmissionPolicy.ReadWrite.All" - }, - { - "description": "Allows an app to read the browser site lists configured for your organization, on behalf of the signed-in user.", - "displayName": "Read browser site lists for your organization", - "id": "fb9be2b7-a7fc-4182-aec1-eda4597c43d5", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read the browser site lists configured for your organization, on your behalf.", - "userConsentDisplayName": "Read browser site lists for your organization", - "value": "BrowserSiteLists.Read.All" - }, - { - "description": "Allows the application to list and query any shared user profile information associated with the current tenant on behalf of the signed-in user.\u00a0 It also permits the application to export and remove external user data (e.g. customer content or system-generated logs), for any user associated with the current tenant on behalf of the signed-in user.", - "displayName": "Read all shared cross-tenant user profiles and export or delete their data", - "id": "64dfa325-cbf8-48e3-938d-51224a0cac01", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to list and query any shared user profile information associated with the current tenant on your behalf.\u00a0 It also permits the application to export and remove external user data (e.g. customer content or system-generated logs), for any user associated with the current tenant on your behalf.", - "userConsentDisplayName": "Read any shared cross-tenant user profiles and export or delete data", - "value": "CrossTenantUserProfileSharing.ReadWrite.All" - }, - { - "description": "Allows the app to read the threat submissions and threat submission policies owned by the signed-in user.", - "displayName": "Read threat submissions", - "id": "fd5353c6-26dd-449f-a565-c4e16b9fce78", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the threat submissions and threat submission policies that you own on your behalf.", - "userConsentDisplayName": "Read threat submissions", - "value": "ThreatSubmission.Read" - }, - { - "description": "Allows the app to read the threat submissions and threat submission policies owned by the signed-in user. Also allows the app to create new threat submissions on behalf of the signed-in user.", - "displayName": "Read and write threat submissions", - "id": "68a3156e-46c9-443c-b85c-921397f082b5", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the threat submissions and threat submission policies that you own. Also allows the app to create new threat submissions on your behalf.", - "userConsentDisplayName": "Read and write threat submissions", - "value": "ThreatSubmission.ReadWrite" - }, - { - "description": "Allows the app to read all recordings of online meetings, on behalf of the signed-in user.", - "displayName": "Read all recordings of online meetings.", - "id": "190c2bb6-1fdd-4fec-9aa2-7d571b5e1fe3", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all recordings of online meetings, on your behalf.\u00a0", - "userConsentDisplayName": "Read all recordings of online meetings.\u00a0", - "value": "OnlineMeetingRecording.Read.All" - }, - { - "description": "Allows the application to obtain basic tenant information about another target tenant within the Azure AD ecosystem on behalf of the signed-in user.", - "displayName": "Read cross-tenant basic information", - "id": "81594d25-e88e-49cf-ac8c-fecbff49f994", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to obtain basic tenant information about another target tenant within the Azure AD ecosystem on your behalf.", - "userConsentDisplayName": "Read cross-tenant basic information", - "value": "CrossTenantInformation.ReadBasic.All" - }, - { - "description": "Allows the app to read your organization's authentication event listeners on behalf of the signed-in user.", - "displayName": "Read your organization's authentication event listeners", - "id": "f7dd3bed-5eec-48da-bc73-1c0ef50bc9a1", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization's authentication event listeners on your behalf.", - "userConsentDisplayName": "Read your organization's authentication event listeners", - "value": "EventListener.Read.All" - }, - { - "description": "Allows the app to read the Teams app settings on behalf of the signed-in user.", - "displayName": "Read Teams app settings", - "id": "44e060c4-bbdc-4256-a0b9-dcc0396db368", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the Teams app settings on your behalf.", - "userConsentDisplayName": "Read Teams app settings", - "value": "TeamworkAppSettings.Read.All" - }, - { - "description": "Allows\u00a0the\u00a0app\u00a0to\u00a0manage learning\u00a0content\u00a0in\u00a0the\u00a0organization's\u00a0directory, on behalf of the signed-in user.", - "displayName": "Manage\u00a0learning\u00a0content", - "id": "53cec1c4-a65f-4981-9dc1-ad75dbf1c077", - "Origin": "Delegated", - "userConsentDescription": "Allows\u00a0the\u00a0app\u00a0to\u00a0manage learning\u00a0content\u00a0in\u00a0the\u00a0organization's\u00a0directory, on your behalf.", - "userConsentDisplayName": "Manage learning content", - "value": "LearningContent.ReadWrite.All" - }, - { - "description": "Allows the app to create, update, read, and delete data for the learning provider in the organization's directory, on behalf of the signed-in user.", - "displayName": "Manage\u00a0learning\u00a0provider", - "id": "40c2eb57-abaf-49f5-9331-e90fd01f7130", - "Origin": "Delegated", - "userConsentDescription": "Allows\u00a0the\u00a0app\u00a0to\u00a0create, update, read, and delete\u00a0data\u00a0for\u00a0the learning\u00a0provider\u00a0in\u00a0the organization's\u00a0directory, on your behalf.", - "userConsentDisplayName": "Manage learning provider", - "value": "LearningProvider.ReadWrite" - }, - { - "description": "Allows the app to read the lifecycle information like employeeLeaveDateTime of users in your organization, on behalf of the signed-in user.", - "displayName": "Read all users' lifecycle information", - "id": "ed8d2a04-0374-41f1-aefe-da8ac87ccc87", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read the lifecycle information like employeeLeaveDateTime of users in your organization, on behalf of the signed-in user.", - "userConsentDisplayName": "Read all users' lifecycle information", - "value": "User-LifeCycleInfo.Read.All" - }, - { - "description": "Allows an app to read and write the browser site lists configured for your organization, on behalf of the signed-in user.", - "displayName": "Read and write browser site lists for your organization", - "id": "83b34c85-95bf-497b-a04e-b58eca9d49d0", - "Origin": "Delegated", - "userConsentDescription": "Allows an app to read and write the browser site lists configured for your organization, on your behalf.", - "userConsentDisplayName": "Read and write browser site lists for your organization", - "value": "BrowserSiteLists.ReadWrite.All" - }, - { - "description": "Allows the application to list and query user profile information associated with the current tenant on behalf of the signed-in user.\u00a0 It also permits the application to export external user data (e.g. customer content or system-generated logs), associated with the current tenant on behalf of the signed-in user.", - "displayName": "Read shared cross-tenant user profile and export data", - "id": "cb1ba48f-d22b-4325-a07f-74135a62ee41", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to list and query shared user profile information associated with the current tenant on your behalf.\u00a0 It also permits the application to export your external user data (e.g. customer content or system-generated logs), associated with the current tenant on your behalf.", - "userConsentDisplayName": "Read shared cross-tenant user profile and export data", - "value": "CrossTenantUserProfileSharing.Read" - }, - { - "description": "Allows the app to read admin report settings, such as whether to display concealed information in reports, on behalf of the signed-in user", - "displayName": "Read admin report settings", - "id": "84fac5f4-33a9-4100-aa38-a20c6d29e5e7", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read admin report settings, such as whether to display concealed information in reports, on your behalf.", - "userConsentDisplayName": "Read admin report settings", - "value": "ReportSettings.Read.All" - }, - { - "description": "Allows the app to read and write the lifecycle information like employeeLeaveDateTime of users in your organization, on behalf of the signed-in user.", - "displayName": "Read and write all users' lifecycle information", - "id": "7ee7473e-bd4b-4c9f-987c-bd58481f5fa2", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the lifecycle information like employeeLeaveDateTime of users in your organization, on behalf of the signed-in user.", - "userConsentDisplayName": "Read and write all users' lifecycle information", - "value": "User-LifeCycleInfo.ReadWrite.All" - }, - { - "description": "Allows the app to read and update Azure AD recommendations, on behalf of the signed-in user. ", - "displayName": "Read and update Azure AD recommendations", - "id": "f37235e8-90a0-4189-93e2-e55b53867ccd", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and update Azure AD recommendations, on your behalf.", - "userConsentDisplayName": "Read and update Azure AD recommendations", - "value": "DirectoryRecommendations.ReadWrite.All" - }, - { - "description": "Allows the app to read your organization's threat submissions and threat submission policies on behalf of the signed-in user.", - "displayName": "Read all threat submissions", - "id": "7083913a-4966-44b6-9886-c5822a5fd910", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization's threat submissions and threat submission policies on your behalf.", - "userConsentDisplayName": "Read all threat submissions", - "value": "ThreatSubmission.Read.All" - }, - { - "description": "Allows the app to read learning content in the organization's directory, on behalf of the signed-in user.", - "displayName": "Read learning content", - "id": "ea4c1fd9-6a9f-4432-8e5d-86e06cc0da77", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read learning content in the organization's directory, on your behalf.", - "userConsentDisplayName": "Read learning content", - "value": "LearningContent.Read.All" - }, - { - "description": "Allows the app to read data for the learning provider in the organization's directory, on behalf of the signed-in user.", - "displayName": "Read learning provider", - "id": "dd8ce36f-9245-45ea-a99e-8ac398c22861", - "Origin": "Delegated", - "userConsentDescription": "Allows\u00a0the\u00a0app\u00a0to\u00a0read\u00a0data\u00a0for\u00a0the learning\u00a0provider\u00a0in\u00a0the organization's\u00a0directory, on your behalf.", - "userConsentDisplayName": "Read learning provider", - "value": "LearningProvider.Read" - }, - { - "description": "Allows the app to create, update, list, read and delete all workflows, tasks and related lifecycle workflows resources on behalf of the signed-in user.", - "displayName": "Read and write all lifecycle workflows resources", - "id": "84b9d731-7db8-4454-8c90-fd9e95350179", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to create, update, list, read and delete all workflows, tasks and related lifecycle workflows resources on your behalf.", - "userConsentDisplayName": "Read and write all lifecycle workflows resources", - "value": "LifecycleWorkflows.ReadWrite.All" - }, - { - "description": "Allows an app to read all bookmarks that the signed-in user can access.", - "displayName": "Read all bookmarks that the user can access", - "id": "98b17b35-f3b1-4849-a85f-9f13733002f0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all bookmarks you can access.", - "userConsentDisplayName": "Read all bookmarks that you have access to", - "value": "Bookmark.Read.All" - }, - { - "description": "Allows the application to read and change the tenant-level settings of SharePoint and OneDrive on behalf of the signed-in user.", - "displayName": "Read and change SharePoint and OneDrive tenant settings", - "id": "aa07f155-3612-49b8-a147-6c590df35536", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read and change the tenant-level settings of SharePoint and OneDrive on your behalf.", - "userConsentDisplayName": "Read and change SharePoint and OneDrive tenant settings", - "value": "SharePointTenantSettings.ReadWrite.All" - }, - { - "description": "Allows the app to read or write your organization's authentication event listeners on behalf of the signed-in user.", - "displayName": "Read and write your organization's authentication event listeners", - "id": "d11625a6-fe21-4fc6-8d3d-063eba5525ad", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read or write your organization's authentication event listeners on your behalf.", - "userConsentDisplayName": "Read and write your organization's authentication event listeners", - "value": "EventListener.ReadWrite.All" - }, - { - "description": "Allows the app to read and write the Teams app settings on behalf of the signed-in user.", - "displayName": "Read and write Teams app settings", - "id": "87c556f0-2bd9-4eed-bd74-5dd8af6eaf7e", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write the Teams app settings on your behalf.", - "userConsentDisplayName": "Read and write Teams app settings", - "value": "TeamworkAppSettings.ReadWrite.All" - }, - { - "description": "Allows the app to read all authentication context information in your organization on behalf of the signed-in user.", - "displayName": "Read all authentication context information", - "id": "57b030f1-8c35-469c-b0d9-e4a077debe70", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all authentication context information in your organization on your behalf.", - "userConsentDisplayName": "Read all authentication context information", - "value": "AuthenticationContext.Read.All" - }, - { - "description": "Allows the app to read and update all authentication context information in your organization on behalf of the signed-in user.", - "displayName": "Read and write all authentication context information", - "id": "ba6d575a-1344-4516-b777-1404f5593057", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and update all authentication context information in your organization on your behalf.", - "userConsentDisplayName": "Read and write all authentication context information", - "value": "AuthenticationContext.ReadWrite.All" - }, - { - "description": "Allows the app to read and update admin report settings, such as whether to display concealed information in reports, on behalf of the signed-in user.", - "displayName": "Read and write admin report settings", - "id": "b955410e-7715-4a88-a940-dfd551018df3", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and update admin report settings, such as whether to display concealed information in reports, on your behalf.", - "userConsentDisplayName": "Read and write admin report settings", - "value": "ReportSettings.ReadWrite.All" - }, - { - "description": "Allows the app to list and read all workflows, tasks and related lifecycle workflows resources on behalf of the signed-in user.", - "displayName": "Read all lifecycle workflows resources", - "id": "9bcb9916-765a-42af-bf77-02282e26b01a", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to list and read all workflows, tasks and related lifecycle workflows resources on your behalf.", - "userConsentDisplayName": "Read all lifecycle workflows resources", - "value": "LifecycleWorkflows.Read.All" - }, - { - "description": "Allows the application to list and query any shared user profile information associated with the current tenant on behalf of the signed-in user.\u00a0 It also permits the application to export external user data (e.g. customer content or system-generated logs), for any user associated with the current tenant on behalf of the signed-in user.", - "displayName": "Read all shared cross-tenant user profiles and export their data", - "id": "759dcd16-3c90-463c-937e-abf89f991c18", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to list and query any shared user profile information associated with the current tenant on your behalf.\u00a0 It also permits the application to export external user data (e.g. customer content or system-generated logs), for any user associated with the current tenant on your behalf.", - "userConsentDisplayName": "Read any shared cross-tenant user profiles and export data", - "value": "CrossTenantUserProfileSharing.Read.All" - }, - { - "description": "Allows the application to read the tenant-level settings in SharePoint and OneDrive on behalf of the signed-in user.", - "displayName": "Read SharePoint and OneDrive tenant settings", - "id": "2ef70e10-5bfd-4ede-a5f6-67720500b258", - "Origin": "Delegated", - "userConsentDescription": "Allows the application to read the tenant-level settings in SharePoint and OneDrive on your behalf.", - "userConsentDisplayName": "Read SharePoint and OneDrive tenant settings", - "value": "SharePointTenantSettings.Read.All" - }, - { - "description": "Allows the app to read or write your organization's custom authentication extensions on behalf of the signed-in user.", - "displayName": "Read and write your organization's custom authentication extensions", - "id": "8dfcf82f-15d0-43b3-bc78-a958a13a5792", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read or write your organization's custom authentication extensions on your behalf.", - "userConsentDisplayName": "Read and write your organization's custom authentication extensions", - "value": "CustomAuthenticationExtension.ReadWrite.All" - }, - { - "description": "Allows an app to manage license assignments for users and groups, on behalf of the signed-in user.", - "displayName": "Manage all license assignments", - "id": "f55016cc-149c-447e-8f21-7cf3ec1d6350", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to manage all license assignments, on your behalf.", - "userConsentDisplayName": "Manage all license assignments", - "value": "LicenseAssignment.ReadWrite.All" - }, - { - "description": "Allows an app to read all acronyms that the signed-in user can access.", - "displayName": "Read all acronyms that the user can access", - "id": "9084c10f-a2d6-4713-8732-348def50fe02", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all acronyms you can access.", - "userConsentDisplayName": "Read all acronyms that you have access to", - "value": "Acronym.Read.All" - }, - { - "description": "Allows the app to read your organization's custom authentication extensions on behalf of the signed-in user.", - "displayName": "Read your oganization's custom authentication extensions", - "id": "b2052569-c98c-4f36-a5fb-43e5c111e6d0", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read your organization's custom authentication extensions on your behalf.", - "userConsentDisplayName": "Read your organization's custom authentication extensions", - "value": "CustomAuthenticationExtension.Read.All" - }, - { - "description": "Allows the app to read all transcripts of online meetings, on behalf of the signed-in user.", - "displayName": "Read all transcripts of online meetings. ", - "id": "30b87d18-ebb1-45db-97f8-82ccb1f0190c", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read all transcripts of online meetings, on your behalf.", - "userConsentDisplayName": "Read all transcripts of online meetings.", - "value": "OnlineMeetingTranscript.Read.All" - }, - { - "description": "Allows the app to read and write channel messages, on behalf of the signed-in user. This doesn't allow the app to edit the policyViolation of a channel message.", - "displayName": "Read and write user channel messages", - "id": "5922d31f-46c8-4404-9eaf-2117e390a8a4", - "Origin": "Delegated", - "userConsentDescription": "Allows the app to read and write channel messages, on your behalf. This doesn't allow the app to edit the policyViolation of a channel message.", - "userConsentDisplayName": "Read and write user channel messages", - "value": "ChannelMessage.ReadWrite" - }, - { - "description": "Read Threat and Vulnerability Management vulnerability information", - "displayName": "Allows the app to read any Threat and Vulnerability Management vulnerability information", - "id": "63a677ce-818c-4409-9d12-5c6d2e2a6bfe", - "Origin": "Application (WindowsDefenderATP)", - "userConsentDescription": "Allows the app to read any Threat and Vulnerability Management vulnerability information", - "userConsentDisplayName": "Allows the app to read any Threat and Vulnerability Management vulnerability information", - "value": "Vulnerability.Read.All" - }, - { - "description": "Allows the app to read Threat and Vulnerability Management vulnerability information on behalf of the signed-in user", - "displayName": "Read Threat and Vulnerability Management vulnerability information", - "id": "41269fc5-d04d-4bfd-bce7-43a51cea049a", - "Origin": "Delegated (WindowsDefenderATP)", - "userConsentDescription": "Allows the app to read Threat and Vulnerability Management vulnerability information on behalf of the signed-in user", - "userConsentDisplayName": "Read Threat and Vulnerability Management vulnerability information", - "value": "Vulnerability.Read" - }, - { - "description": "Allows the app to manage Exchange Online", - "displayName": "Manage Exchange online", - "id": "ab4f2b77-0b06-4fc1-a9de-02113fc2ab7c", - "Origin": "Delegated (Office 365 Exchange Online)", - "userConsentDescription": "Allows the app to read Threat and Vulnerability Management vulnerability information on behalf of the signed-in user", - "userConsentDisplayName": "Read Threat and Vulnerability Management vulnerability information", - "value": "Exchange.Manage" - }, - { - "description": "Allows the app to create, read, update and delete events in all calendars in the organization user has permissions to access. This includes delegate and shared calendars", - "displayName": "Read and write user and shared calendars", - "id": "bbd1ca91-75e0-4814-ad94-9c5dbbae3415", - "Origin": "Delegated (Office 365 Exchange Online)", - "userConsentDescription": "Allows the app to read, update, create and delete events in all calendars in your organization you have permissions to access. This includes delegate and shared calendars", - "userConsentDisplayName": "Read and write to your and shared calendars", - "value": "Calendars.ReadWrite.All" - }, - { - "description": "Allows the app to create, read, update, and delete user's mailbox settings. Does not include permission to send mail.", - "displayName": "Read and write user mailbox settings", - "id": "2e83d72d-8895-4b66-9eea-abb43449ab8b", - "Origin": "Delegated (Office 365 Exchange Online)", - "userConsentDescription": "Allows the app to read, update, create, and delete your mailbox settings.", - "userConsentDisplayName": "Read and write to your mailbox settings", - "value": "MailboxSettings.ReadWrite" - }, - { - "description": "Allows the app to have full control of all site collections on behalf of the signed-in user.", - "displayName": "Manage Sharepoint Online", - "id": "56680e0d-d2a3-4ae1-80d8-3c4f2100e3d0", - "Origin": "Delegated (Office 365 SharePoint Online)", - "userConsentDescription": "Have full control of all site collections", - "userConsentDisplayName": "Allows the app to have full control of all site collections on your behalf.", - "value": "AllSites.FullControl" - }, - { - "description": "Allows to read the LAPs passwords.", - "displayName": "Manage LAPs passwords", - "id": "280b3b69-0437-44b1-bc20-3b2fca1ee3e9", - "Origin": "Delegated", - "userConsentDescription": "Allows to read the LAPs passwords.", - "userConsentDisplayName": "Manage LAPs passwords", - "value": "DeviceLocalCredential.Read.All" - }, - { - "description": "Access Microsoft Teams and Skype for Business data as the signed in user", - "displayName": "Access Microsoft Teams and Skype for Business data based on the user's role membership", - "id": "e60370c1-e451-437e-aa6e-d76df38e5f15", - "Origin": "Delegated (Skype and Teams Tenant Admin API)", - "userConsentDescription": "Access Microsoft Teams and Skype for Business data as the signed in user", - "userConsentDisplayName": "Access Microsoft Teams and Skype for Business data based on the user's role membership", - "value": "user_impersonation" - }, - { - "description": "Read and write all on-premises directory synchronization information", - "displayName": "Read and write all on-premises directory synchronization information", - "id": "c2d95988-7604-4ba1-aaed-38a5f82a51c7", - "Origin": "Delegated", - "userConsentDescription": "Access Microsoft Teams and Skype for Business data as the signed in user", - "userConsentDisplayName": "Access Microsoft Teams and Skype for Business data based on the user's role membership", - "value": "OnPremDirectorySynchronization.ReadWrite.All" - } -] diff --git a/Cache_SAMSetup/SAMManifest.json b/Cache_SAMSetup/SAMManifest.json deleted file mode 100644 index f94959dc3ac6..000000000000 --- a/Cache_SAMSetup/SAMManifest.json +++ /dev/null @@ -1,194 +0,0 @@ -{ - "isFallbackPublicClient": true, - "signInAudience": "AzureADMultipleOrgs", - "displayName": "CIPP-SAM", - "web": { - "redirectUris": [ - "https://login.microsoftonline.com/common/oauth2/nativeclient", - "https://localhost", - "http://localhost", - "http://localhost:8400" - ] - }, - "requiredResourceAccess": [ - { - "resourceAppId": "aeb86249-8ea3-49e2-900b-54cc8e308f85", - "resourceAccess": [ - { "id": "fc946a4f-bc4d-413b-a090-b2c86113ec4f", "type": "Scope" } - ] - }, - { - "resourceAppId": "fa3d9a0c-3fb0-42cc-9193-47c7ecd2edbd", - "resourceAccess": [ - { "id": "1cebfa2a-fb4d-419e-b5f9-839b4383e05a", "type": "Scope" } - ] - }, - { - "resourceAppId": "00000003-0000-0000-c000-000000000000", - "resourceAccess": [ - { "id": "aa07f155-3612-49b8-a147-6c590df35536", "type": "Scope" }, - { "id": "73e75199-7c3e-41bb-9357-167164dbb415", "type": "Scope" }, - { "id": "d01b97e9-cbc0-49fe-810a-750afd5527a3", "type": "Scope" }, - { "id": "46ca0847-7e6b-426e-9775-ea810a948356", "type": "Scope" }, - { "id": "dc38509c-b87d-4da0-bd92-6bec988bac4a", "type": "Scope" }, - { "id": "7427e0e9-2fba-42fe-b0c0-848c9e6a8182", "type": "Scope" }, - { "id": "ad902697-1014-4ef5-81ef-2b4301988e8c", "type": "Scope" }, - { "id": "572fea84-0151-49b2-9301-11cb16974376", "type": "Scope" }, - { "id": "e4c9e354-4dc5-45b8-9e7c-e1393b0b1a20", "type": "Scope" }, - { "id": "0883f392-0a7a-443d-8c76-16a6d39c7b63", "type": "Scope" }, - { "id": "7b3f05d5-f68c-4b8d-8c59-a2ecd12f24af", "type": "Scope" }, - { "id": "0c5e8a55-87a6-4556-93ab-adc52c4d862d", "type": "Scope" }, - { "id": "44642bfe-8385-4adc-8fc6-fe3cb2c375c3", "type": "Scope" }, - { "id": "662ed50a-ac44-4eef-ad86-62eed9be2a29", "type": "Scope" }, - { "id": "6aedf524-7e1c-45a7-bd76-ded8cab8d0fc", "type": "Scope" }, - { "id": "bac3b9c2-b516-4ef4-bd3b-c2ef73d8d804", "type": "Scope" }, - { "id": "11d4cd79-5ba5-460f-803f-e22c8ab85ccd", "type": "Scope" }, - { "id": "02e97553-ed7b-43d0-ab3c-f8bace0d040c", "type": "Scope" }, - { "id": "89fe6a52-be36-487e-b7d8-d061c450a026", "type": "Scope" }, - { "id": "a367ab51-6b49-43bf-a716-a1fb06d2a174", "type": "Scope" }, - { "id": "204e0828-b5ca-4ad8-b9f3-f32a958e7cc4", "type": "Scope" }, - { "id": "4e46008b-f24c-477d-8fff-7bb4ec7aafe0", "type": "Scope" }, - { "id": "0e263e50-5827-48a4-b97c-d940288653c7", "type": "Scope" }, - { "id": "e383f46e-2787-4529-855e-0e479a3ffac0", "type": "Scope" }, - { "id": "37f7f235-527c-4136-accd-4a02d197296e", "type": "Scope" }, - { "id": "14dad69e-099b-42c9-810b-d002981feec1", "type": "Scope" }, - { "id": "f6a3db3e-f7e8-4ed2-a414-557c8c9830be", "type": "Scope" }, - { "id": "0e755559-83fb-4b44-91d0-4cc721b9323e", "type": "Scope" }, - { "id": "a84a9652-ffd3-496e-a991-22ba5529156a", "type": "Scope" }, - { "id": "1d89d70c-dcac-4248-b214-903c457af83a", "type": "Scope" }, - { "id": "2b61aa8a-6d36-4b2f-ac7b-f29867937c53", "type": "Scope" }, - { "id": "ebf0f66e-9fb1-49e4-a278-222f76911cf4", "type": "Scope" }, - { "id": "bdfbf15f-ee85-4955-8675-146e8e5296b5", "type": "Scope" }, - { "id": "f81125ac-d3b7-4573-a3b2-7099cc39df9e", "type": "Scope" }, - { "id": "cac97e40-6730-457d-ad8d-4852fddab7ad", "type": "Scope" }, - { "id": "b7887744-6746-4312-813d-72daeaee7e2d", "type": "Scope" }, - { "id": "48971fc1-70d7-4245-af77-0beb29b53ee2", "type": "Scope" }, - { "id": "aec28ec7-4d02-4e8c-b864-50163aea77eb", "type": "Scope" }, - { "id": "a9ff19c2-f369-4a95-9a25-ba9d460efc8e", "type": "Scope" }, - { "id": "b98bfd41-87c6-45cc-b104-e2de4f0dafb9", "type": "Scope" }, - { "id": "2f9ee017-59c1-4f1d-9472-bd5529a7b311", "type": "Scope" }, - { "id": "951183d1-1a61-466f-a6d1-1fde911bfd95", "type": "Scope" }, - { "id": "637d7bec-b31e-4deb-acc9-24275642a2c9", "type": "Scope" }, - { "id": "101147cf-4178-4455-9d58-02b5c164e759", "type": "Scope" }, - { "id": "cc83893a-e232-4723-b5af-bd0b01bcfe65", "type": "Scope" }, - { "id": "233e0cf1-dd62-48bc-b65b-b38fe87fcf8e", "type": "Scope" }, - { "id": "d649fb7c-72b4-4eec-b2b4-b15acf79e378", "type": "Scope" }, - { "id": "485be79e-c497-4b35-9400-0e3fa7f2a5d4", "type": "Scope" }, - { "id": "9d8982ae-4365-4f57-95e9-d6032a4c0b87", "type": "Scope" }, - { "id": "48638b3c-ad68-4383-8ac4-e6880ee6ca57", "type": "Scope" }, - { "id": "39d65650-9d3e-4223-80db-a335590d027e", "type": "Scope" }, - { "id": "4a06efd2-f825-4e34-813e-82a57b03d1ee", "type": "Scope" }, - { "id": "f3bfad56-966e-4590-a536-82ecf548ac1e", "type": "Scope" }, - { "id": "4d135e65-66b8-41a8-9f8b-081452c91774", "type": "Scope" }, - { "id": "2eadaff8-0bce-4198-a6b9-2cfc35a30075", "type": "Scope" }, - { "id": "0c3e411a-ce45-4cd1-8f30-f99a3efa7b11", "type": "Scope" }, - { "id": "edb72de9-4252-4d03-a925-451deef99db7", "type": "Scope" }, - { "id": "767156cb-16ae-4d10-8f8b-41b657c8c8c8", "type": "Scope" }, - { "id": "7e823077-d88e-468f-a337-e18f1f0e6c7c", "type": "Scope" }, - { "id": "edd3c878-b384-41fd-95ad-e7407dd775be", "type": "Scope" }, - { "id": "40b534c3-9552-4550-901b-23879c90bcf9", "type": "Scope" }, - { "id": "7825d5d6-6049-4ce7-bdf6-3b8d53f4bcd0", "type": "Scope" }, - { "id": "2104a4db-3a2f-4ea0-9dba-143d457dc666", "type": "Scope" }, - { "id": "eda39fa6-f8cf-4c3c-a909-432c683e4c9b", "type": "Scope" }, - { "id": "55896846-df78-47a7-aa94-8d3d4442ca7f", "type": "Scope" }, - { "id": "128ca929-1a19-45e6-a3b8-435ec44a36ba", "type": "Scope" }, - { "id": "b27add92-efb2-4f16-84f5-8108ba77985c", "type": "Scope" }, - { "id": "3404d2bf-2b13-457e-a330-c24615765193", "type": "Scope" }, - { "id": "b955410e-7715-4a88-a940-dfd551018df3", "type": "Scope" }, - { "id": "5b07b0dd-2377-4e44-a38d-703f09a0dc3c", "type": "Role" }, - { "id": "19b94e34-907c-4f43-bde9-38b1909ed408", "type": "Role" }, - { "id": "999f8c63-0a38-4f1b-91fd-ed1947bdd1a9", "type": "Role" }, - { "id": "292d869f-3427-49a8-9dab-8c70152b74e9", "type": "Role" }, - { "id": "2f51be20-0bb4-4fed-bf7b-db946066c75e", "type": "Role" }, - { "id": "58ca0d9a-1575-47e1-a3cb-007ef2e4583b", "type": "Role" }, - { "id": "06a5fe6d-c49d-46a7-b082-56b1b14103c7", "type": "Role" }, - { "id": "246dd0d5-5bd0-4def-940b-0421030a5b68", "type": "Role" }, - { "id": "bf394140-e372-4bf9-a898-299cfc7564e5", "type": "Role" }, - { "id": "741f803b-c850-494e-b5df-cde7c675a1ca", "type": "Role" }, - { "id": "230c1aed-a721-4c5d-9cb4-a90514e508ef", "type": "Role" }, - { "id": "b633e1c5-b582-4048-a93e-9f11b44c7e96", "type": "Role" }, - { "id": "5b567255-7703-4780-807c-7be8301ae99b", "type": "Role" }, - { "id": "62a82d76-70ea-41e2-9197-370581804d09", "type": "Role" }, - { "id": "7ab1d382-f21e-4acd-a863-ba3e13f7da61", "type": "Role" }, - { "id": "1138cb37-bd11-4084-a2b7-9f71582aeddb", "type": "Role" }, - { "id": "78145de6-330d-4800-a6ce-494ff2d33d07", "type": "Role" }, - { "id": "9241abd9-d0e6-425a-bd4f-47ba86e767a4", "type": "Role" }, - { "id": "5b07b0dd-2377-4e44-a38d-703f09a0dc3c", "type": "Role" }, - { "id": "243333ab-4d21-40cb-a475-36241daa0842", "type": "Role" }, - { "id": "e330c4f0-4170-414e-a55a-2f022ec2b57b", "type": "Role" }, - { "id": "5ac13192-7ace-4fcf-b828-1a26f28068ee", "type": "Role" }, - { "id": "2f6817f8-7b12-4f0f-bc18-eeaf60705a9e", "type": "Role" }, - { "id": "dbaae8cf-10b5-4b86-a4a1-f871c94c6695", "type": "Role" }, - { "id": "bf7b1a76-6e77-406b-b258-bf5c7720e98f", "type": "Role" }, - { "id": "01c0a623-fc9b-48e9-b794-0756f8e8f067", "type": "Role" }, - { "id": "50483e42-d915-4231-9639-7fdb7fd190e5", "type": "Role" }, - { "id": "dbb9058a-0e50-45d7-ae91-66909b5d4664", "type": "Role" }, - { "id": "a82116e5-55eb-4c41-a434-62fe8a61c773", "type": "Role" }, - { "id": "f3a65bd4-b703-46df-8f7e-0174fea562aa", "type": "Role" }, - { "id": "59a6b24b-4225-4393-8165-ebaec5f55d7a", "type": "Role" }, - { "id": "0121dc95-1b9f-4aed-8bac-58c5ac466691", "type": "Role" }, - { "id": "3b55498e-47ec-484f-8136-9013221c06a9", "type": "Role" }, - { "id": "35930dcf-aceb-4bd1-b99a-8ffed403c974", "type": "Role" }, - { "id": "25f85f3c-f66c-4205-8cd5-de92dd7f0cec", "type": "Role" }, - { "id": "29c18626-4985-4dcd-85c0-193eef327366", "type": "Role" }, - { "id": "4437522e-9a86-4a41-a7da-e380edd4a97d", "type": "Role" }, - { "id": "34bf0e97-1971-4929-b999-9e2442d941d7", "type": "Role" }, - { "id": "45cc0394-e837-488b-a098-1918f48d186c", "type": "Role" }, - { "id": "be74164b-cff1-491c-8741-e671cb536e13", "type": "Role" }, - { "id": "2a60023f-3219-47ad-baa4-40e17cd02a1d", "type": "Role" }, - { "id": "338163d7-f101-4c92-94ba-ca46fe52447c", "type": "Role" }, - { "id": "cac88765-0581-4025-9725-5ebc13f729ee", "type": "Role" }, - { "id": "75359482-378d-4052-8f01-80520e7db3cd", "type": "Role" }, - { "id": "19dbc75e-c2e2-444c-a770-ec69d8559fc7", "type": "Role" }, - { "id": "b27a61ec-b99c-4d6a-b126-c4375d08ae30", "type": "Scope" }, - { "id": "84bccea3-f856-4a8a-967b-dbe0a3d53a64", "type": "Scope" }, - { "id": "280b3b69-0437-44b1-bc20-3b2fca1ee3e9", "type": "Scope" }, - { "id": "885f682f-a990-4bad-a642-36736a74b0c7", "type": "Scope" }, - { "id": "913b9306-0ce1-42b8-9137-6a7df690a760", "type": "Role" }, - { "id": "4c06a06a-098a-4063-868e-5dfee3827264", "type": "Scope" }, - { "id": "1bfefb4e-e0b5-418b-a88f-73c46d2cc8e9", "type": "Role" }, - { "id": "e67e6727-c080-415e-b521-e3f35d5248e9", "type": "Scope" }, - { "id": "b6890674-9dd5-4e42-bb15-5af07f541ae1", "type": "Role" }, - { "id": "9e4862a5-b68f-479e-848a-4e07e25c9916", "type": "Scope" }, - { "id": "bb6f654c-d7fd-4ae3-85c3-fc380934f515", "type": "Scope" }, - { "id": "e0a7cdbb-08b0-4697-8264-0069786e9674", "type": "Scope" } - ] - }, - { - "resourceAppId": "fc780465-2017-40d4-a0c5-307022471b92", - "resourceAccess": [ - { "id": "63a677ce-818c-4409-9d12-5c6d2e2a6bfe", "type": "Scope" }, - { "id": "41269fc5-d04d-4bfd-bce7-43a51cea049a", "type": "Role" } - ] - }, - { - "resourceAppId": "00000002-0000-0ff1-ce00-000000000000", - "resourceAccess": [ - { "id": "ab4f2b77-0b06-4fc1-a9de-02113fc2ab7c", "type": "Scope" }, - { "id": "bbd1ca91-75e0-4814-ad94-9c5dbbae3415", "type": "Scope" }, - { "id": "2e83d72d-8895-4b66-9eea-abb43449ab8b", "type": "Scope" }, - { "id": "dc50a0fb-09a3-484d-be87-e023b12c6440", "type": "Role" }, - { "id": "ef54d2bf-783f-4e0f-bca1-3210c0444d99", "type": "Role" }, - { "id": "f9156939-25cd-4ba8-abfe-7fabcf003749", "type": "Role" } - ] - }, - { - "resourceAppId": "00000003-0000-0ff1-ce00-000000000000", - "resourceAccess": [ - { "id": "56680e0d-d2a3-4ae1-80d8-3c4f2100e3d0", "type": "Scope" } - ] - }, - { - "resourceAppId": "48ac35b8-9aa8-4d74-927d-1f4a14a0b239", - "resourceAccess": [ - { "id": "e60370c1-e451-437e-aa6e-d76df38e5f15", "type": "Scope" } - ] - }, - { - "resourceAppId": "c5393580-f805-4401-95e8-94b7a6ef2fc2", - "resourceAccess": [ - { "id": "594c1fb6-4f81-4475-ae41-0c394909246c", "type": "Scope" } - ] - } - ] -} diff --git a/Cleanup_OldAuditLogs/function.json b/Cleanup_OldAuditLogs/function.json deleted file mode 100644 index 7e97fe568d29..000000000000 --- a/Cleanup_OldAuditLogs/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "type": "timerTrigger", - "direction": "in", - "schedule": "0 0 0 * * *" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/Cleanup_OldAuditLogs/run.ps1 b/Cleanup_OldAuditLogs/run.ps1 deleted file mode 100644 index 738161989a1e..000000000000 --- a/Cleanup_OldAuditLogs/run.ps1 +++ /dev/null @@ -1,9 +0,0 @@ -# Input bindings are passed in via param block. -param($Timer) - -try { - $Tenants = Get-Tenants -IncludeAll | Where-Object { $_.customerId -ne $env:TenantId -and $_.Excluded -eq $false } - $Tenants | ForEach-Object { - Remove-CIPPGraphSubscription -cleanup $true -TenantFilter $_.defaultDomainName - } -} catch {} \ No newline at end of file diff --git a/DomainAnalyser_OrchestrationStarter/function.json b/DomainAnalyser_OrchestrationStarter/function.json deleted file mode 100644 index 14c44f4f0217..000000000000 --- a/DomainAnalyser_OrchestrationStarter/function.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "bindings": [ - { - "authLevel": "anonymous", - "name": "Request", - "type": "httpTrigger", - "direction": "in", - "methods": [ - "post", - "get" - ] - }, - { - "type": "http", - "direction": "out", - "name": "Response" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/DomainAnalyser_OrchestrationStarter/run.ps1 b/DomainAnalyser_OrchestrationStarter/run.ps1 deleted file mode 100644 index 9c16b32afdba..000000000000 --- a/DomainAnalyser_OrchestrationStarter/run.ps1 +++ /dev/null @@ -1,25 +0,0 @@ -using namespace System.Net - -param($Request, $TriggerMetadata) - -$Results = [pscustomobject]@{'Results' = 'Domain Analyser started' } -$TenantList = Get-Tenants -IncludeAll -$Queue = New-CippQueueEntry -Name 'Domain Analyser' -TotalTasks ($TenantList | Measure-Object).Count -$InputObject = [PSCustomObject]@{ - QueueFunction = [PSCustomObject]@{ - FunctionName = 'GetTenants' - DurableName = 'DomainAnalyserTenant' - QueueId = $Queue.RowKey - TenantParams = @{ - IncludeAll = $true - } - } - OrchestratorName = 'DomainAnalyser_Tenants' - SkipLog = $true -} -Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Compress -Depth 5) - -Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{ - StatusCode = [HttpStatusCode]::OK - Body = $results - }) \ No newline at end of file diff --git a/Domain_OrchestrationStarterTimer/function.json b/Domain_OrchestrationStarterTimer/function.json deleted file mode 100644 index f5df3587c4c8..000000000000 --- a/Domain_OrchestrationStarterTimer/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "type": "timerTrigger", - "direction": "in", - "schedule": "0 30 4 * * *" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} \ No newline at end of file diff --git a/Domain_OrchestrationStarterTimer/run.ps1 b/Domain_OrchestrationStarterTimer/run.ps1 deleted file mode 100644 index 8ac7721ca590..000000000000 --- a/Domain_OrchestrationStarterTimer/run.ps1 +++ /dev/null @@ -1,36 +0,0 @@ -param($Timer) - -if ($env:DEV_SKIP_DOMAIN_TIMER) { - Write-Host 'Skipping DomainAnalyser timer' - exit 0 -} - -try { - if ($CurrentlyRunning) { - $Results = [pscustomobject]@{'Results' = 'Already running. Please wait for the current instance to finish' } - Write-LogMessage -API 'DomainAnalyser' -message 'Attempted to start analysis but an instance was already running.' -sev Info - } else { - #$InstanceId = Start-NewOrchestration -FunctionName 'DomainAnalyser_Orchestration' - Write-Host "Started orchestration with ID = '$InstanceId'" - #Orchestrator = New-OrchestrationCheckStatusResponse -Request $Timer -InstanceId $InstanceId - Write-LogMessage -API 'DomainAnalyser' -message 'Starting Domain Analyser' -sev Info - $Results = [pscustomobject]@{'Results' = 'Starting Domain Analyser' } - - $TenantList = Get-Tenants -IncludeAll - $Queue = New-CippQueueEntry -Name 'Domain Analyser' -TotalTasks ($TenantList | Measure-Object).Count - $InputObject = [PSCustomObject]@{ - QueueFunction = [PSCustomObject]@{ - FunctionName = 'GetTenants' - DurableName = 'DomainAnalyserTenant' - QueueId = $Queue.RowKey - TenantParams = @{ - IncludeAll = $true - } - } - OrchestratorName = 'DomainAnalyser_Tenants' - SkipLog = $true - } - Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Compress -Depth 5) - } - Write-Host ($Orchestrator | ConvertTo-Json) -} catch { Write-Host "Domain_OrchestratorStarterTimer Exception $($_.Exception.Message)" } \ No newline at end of file diff --git a/Durable_BECRun/function.json b/Durable_BECRun/function.json deleted file mode 100644 index 7326b39c184d..000000000000 --- a/Durable_BECRun/function.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "bindings": [ - { - "name": "Context", - "type": "orchestrationTrigger", - "direction": "in" - } - ] -} \ No newline at end of file diff --git a/Durable_BECRun/run.ps1 b/Durable_BECRun/run.ps1 deleted file mode 100644 index 44eecff33d2f..000000000000 --- a/Durable_BECRun/run.ps1 +++ /dev/null @@ -1,127 +0,0 @@ -param($Context) -#$Context does not allow itself to be cast to a pscustomobject for some reason, so we convert -$context = $Context | ConvertTo-Json | ConvertFrom-Json -$APIName = $TriggerMetadata.FunctionName -Write-LogMessage -user $request.headers.'x-ms-client-principal' -API $APINAME -message 'Accessed this API' -Sev 'Debug' -$TenantFilter = $Context.input.tenantfilter -$SuspectUser = $Context.input.userid -$UserName = $Context.input.username -Write-Host "Working on $UserName" -try { - $startDate = (Get-Date).AddDays(-7) - $endDate = (Get-Date) - $auditLog = (New-ExoRequest -tenantid $Tenantfilter -cmdlet 'Get-AdminAuditLogConfig').UnifiedAuditLogIngestionEnabled - $7dayslog = if ($auditLog -eq $false) { - $ExtractResult = 'AuditLog is disabled. Cannot perform full analysis' - } else { - $sessionid = Get-Random -Minimum 10000 -Maximum 99999 - $operations = @( - 'New-InboxRule', - 'Set-InboxRule', - 'UpdateInboxRules', - 'Remove-MailboxPermission', - 'Add-MailboxPermission', - 'UpdateCalendarDelegation', - 'AddFolderPermissions', - 'MailboxLogin', - 'UserLoggedIn' - ) - $startDate = (Get-Date).AddDays(-7) - $endDate = (Get-Date) - $SearchParam = @{ - SessionCommand = 'ReturnLargeSet' - Operations = $operations - sessionid = $sessionid - startDate = $startDate - endDate = $endDate - } - do { - New-ExoRequest -tenantid $Tenantfilter -cmdlet 'Search-unifiedAuditLog' -cmdParams $SearchParam -Anchor $Username - Write-Host "Retrieved $($logsTenant.count) logs" -ForegroundColor Yellow - $logsTenant - } while ($LogsTenant.count % 5000 -eq 0 -and $LogsTenant.count -ne 0) - $ExtractResult = 'Successfully extracted logs from auditlog' - } - Try { - $URI = "https://graph.microsoft.com/beta/auditLogs/signIns?`$filter=(userId eq '$SuspectUser')&`$top=1&`$orderby=createdDateTime desc" - $LastSignIn = New-GraphGetRequest -uri $URI -tenantid $TenantFilter -noPagination $true -verbose | Select-Object @{ Name = 'CreatedDateTime'; Expression = { $(($_.createdDateTime | Out-String) -replace '\r\n') } }, - id, - @{ Name = 'AppDisplayName'; Expression = { $_.resourceDisplayName } }, - @{ Name = 'Status'; Expression = { if (($_.conditionalAccessStatus -eq 'Success' -or 'Not Applied') -and $_.status.errorCode -eq 0) { 'Success' } else { 'Failed' } } }, - @{ Name = 'IPAddress'; Expression = { $_.ipAddress } } - } catch { - $LastSignIn = [PSCustomObject]@{ - AppDisplayName = 'Unknown - could not retrieve information. No access to sign-in logs' - CreatedDateTime = 'Unknown' - Id = '0' - Status = 'Could not retrieve additional details' - } - } - #List all users devices - $Bytes = [System.Text.Encoding]::UTF8.GetBytes($SuspectUser) - $base64IdentityParam = [Convert]::ToBase64String($Bytes) - Try { - $Devices = New-GraphGetRequest -uri "https://outlook.office365.com:443/adminapi/beta/$($TenantFilter)/mailbox('$($base64IdentityParam)')/MobileDevice/Exchange.GetMobileDeviceStatistics()/?IsEncoded=True" -Tenantid $tenantfilter -scope ExchangeOnline - } catch { - $Devices = $null - } - $PermissionsLog = ($7dayslog | Where-Object -Property Operations -In 'Remove-MailboxPermission', 'Add-MailboxPermission', 'UpdateCalendarDelegation', 'AddFolderPermissions' ).AuditData | ConvertFrom-Json -Depth 100 | ForEach-Object { - $perms = if ($_.Parameters) { - $_.Parameters | ForEach-Object { if ($_.Name -eq 'AccessRights') { $_.Value } } - } else - { $_.item.ParentFolder.MemberRights } - $objectID = if ($_.ObjectID) { $_.ObjectID } else { $($_.MailboxOwnerUPN) + $_.item.ParentFolder.Path } - [pscustomobject]@{ - Operation = $_.Operation - UserKey = $_.UserKey - ObjectId = $objectId - Permissions = $perms - } - } - - $RulesLog = @(($7dayslog | Where-Object -Property Operations -In 'New-InboxRule', 'Set-InboxRule', 'UpdateInboxRules').AuditData | ConvertFrom-Json) | ForEach-Object { - Write-Host ($_ | ConvertTo-Json) - [pscustomobject]@{ - ClientIP = $_.ClientIP - CreationTime = $_.CreationTime - UserId = $_.UserId - RuleName = ($_.OperationProperties | ForEach-Object { if ($_.Name -eq 'RuleName') { $_.Value } }) - RuleCondition = ($_.OperationProperties | ForEach-Object { if ($_.Name -eq 'RuleCondition') { $_.Value } }) - } - } - $PasswordChanges = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/users?`select=lastPasswordChangeDateTime,displayname,UserPrincipalName" -Tenantid $tenantfilter | Where-Object { $_.lastPasswordChangeDateTime -gt $startDate } - $NewUsers = New-GraphGetRequest -uri "https://graph.microsoft.com/v1.0/users?`$select=displayname,UserPrincipalName,CreatedDateTime" -Tenantid $tenantfilter | Where-Object { $_.CreatedDateTime -gt $startDate } - $MFADevices = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/users/$($SuspectUser)/authentication/methods" -Tenantid $tenantfilter - $NewSPs = New-GraphGetRequest -uri "https://graph.microsoft.com/v1.0/servicePrincipals?`$select=displayName,createdDateTime,id,AppDisplayName&`$filter=createdDateTime ge $($startDate.ToString('yyyy-MM-ddTHH:mm:ssZ'))" -Tenantid $tenantfilter - $Last50Logons = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/auditLogs/signIns?`$top=50&`$orderby=createdDateTime desc" -tenantid $TenantFilter -noPagination $true -verbose | Select-Object @{ Name = 'CreatedDateTime'; Expression = { $(($_.createdDateTime | Out-String) -replace '\r\n') } }, - id, - @{ Name = 'AppDisplayName'; Expression = { $_.resourceDisplayName } }, - @{ Name = 'Status'; Expression = { if (($_.conditionalAccessStatus -eq 'Success' -or 'Not Applied') -and $_.status.errorCode -eq 0) { 'Success' } else { 'Failed' } } }, - @{ Name = 'IPAddress'; Expression = { $_.ipAddress } }, UserPrincipalName - $Results = [PSCustomObject]@{ - AddedApps = @($NewSPs) - SuspectUserMailboxLogons = @($Last50Logons) - LastSuspectUserLogon = @($LastSignIn) - SuspectUserDevices = @($Devices) - NewRules = @($RulesLog) - MailboxPermissionChanges = @($PermissionsLog) - NewUsers = @($NewUsers) - MFADevices = @($MFADevices) - ChangedPasswords = @($PasswordChanges) - ExtractedAt = (Get-Date).ToString('s') - ExtractResult = $ExtractResult - } - -} catch { - $errMessage = Get-NormalizedError -message $_.Exception.Message - $results = [pscustomobject]@{'Results' = "$errMessage" } -} - -$Table = Get-CippTable -tablename 'cachebec' -$Table.Force = $true -Add-CIPPAzDataTableEntity @Table -Entity @{ - UserId = $Context.input.userid - Results = "$($results | ConvertTo-Json -Depth 10)" - RowKey = $Context.input.userid - PartitionKey = 'bec' -} \ No newline at end of file diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.CalendarsAndGroups-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.CalendarsAndGroups-Help.xml deleted file mode 100644 index b232c88dd451..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.CalendarsAndGroups-Help.xml +++ /dev/null @@ -1,21498 +0,0 @@ - - - - - Add-AvailabilityAddressSpace - Add - AvailabilityAddressSpace - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In Exchange Online, you need to run the New-AvailabilityConfig cmdlet before you run the Add-AvailabilityAddressSpace cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Add-AvailabilityAddressSpace - - 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. - - AvailabilityAccessMethod - - AvailabilityAccessMethod - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the username and password that's used to access the Availability services in the target forest. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - AvailabilityAccessMethod - - AvailabilityAccessMethod - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the username and password that's used to access the Availability services in the target forest. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-availabilityaddressspace - - - - - - Add-DistributionGroupMember - Add - DistributionGroupMember - - This cmdlet is available in 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-DistributionGroupMember cmdlet to add a single recipient to distribution groups and mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Add-DistributionGroupMember - - Identity - - The Identity parameter specifies the 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Member - - 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 - - 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. - - RecipientWithAdUserGroupIdParameter - - RecipientWithAdUserGroupIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Member - - 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 - - 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. - - RecipientWithAdUserGroupIdParameter - - RecipientWithAdUserGroupIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Add-DistributionGroupMember -Identity "Staff" -Member "JohnEvans@contoso.com" - - This example adds John Evans to the distribution group named Staff. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-distributiongroupmember - - - - - - Add-MailboxFolderPermission - Add - MailboxFolderPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - To modify the permissions that are assigned to the user on a mailbox folder, use the Set-MailboxFolderPermission cmdlet. To remove all permissions that are assigned to a user on a mailbox folder, use the Remove-MailboxFolderPermission cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Add-MailboxFolderPermission - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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 - - MailboxFolderAccessRight[] - - MailboxFolderAccessRight[] - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - MailboxFolderUserIdParameter - - MailboxFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - Boolean - - Boolean - - - None - - - 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. - - MailboxFolderPermissionFlags - - MailboxFolderPermissionFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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 - - MailboxFolderAccessRight[] - - MailboxFolderAccessRight[] - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - MailboxFolderUserIdParameter - - MailboxFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 - - Boolean - - Boolean - - - None - - - 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. - - MailboxFolderPermissionFlags - - MailboxFolderPermissionFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 Exchange Online, 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 Exchange Online, this example adds Laura as a calendar delegate to Ayla's mailbox with access to private items. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission - - - Get-MailboxFolderPermission - - - - Set-MailboxFolderPermission - - - - Remove-MailboxFolderPermission - - - - Get-EXOMailboxFolderPermission - - - - - - - Export-MailboxDiagnosticLogs - Export - MailboxDiagnosticLogs - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Export-MailboxDiagnosticLogs - - 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) - - GeneralMailboxIdParameter - - GeneralMailboxIdParameter - - - None - - - 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: - - ActionProcessingAgent - - BirthdayAssistant - - CalendarPermissions - - CalendarSharingLocalFolder - - DefaultViewIndexer - - FreeBusyPublishingAssistantQuickLog - - HoldTracking - - InternetCalendar - - InternalCalendarSharingMigration - - MRM - - OnlineMeetings - - OOFRules - - RemindersAssistant - - SharingMigrationAssistant - - SharingSyncAssistant - - SubstrateHoldTracking - - SweepRules - - TimeProfile - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Export-MailboxDiagnosticLogs - - 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) - - GeneralMailboxIdParameter - - GeneralMailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - GeneralMailboxIdParameter - - GeneralMailboxIdParameter - - - None - - - 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: - - ActionProcessingAgent - - BirthdayAssistant - - CalendarPermissions - - CalendarSharingLocalFolder - - DefaultViewIndexer - - FreeBusyPublishingAssistantQuickLog - - HoldTracking - - InternetCalendar - - InternalCalendarSharingMigration - - MRM - - OnlineMeetings - - OOFRules - - RemindersAssistant - - SharingMigrationAssistant - - SharingSyncAssistant - - SubstrateHoldTracking - - SweepRules - - TimeProfile - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/export-mailboxdiagnosticlogs - - - - - - Get-AvailabilityAddressSpace - Get - AvailabilityAddressSpace - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In on-premises Exchange organizations, you run the Remove-AvailabilityAddressSpace cmdlet on Exchange servers that have the Client Access server role installed. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AvailabilityAddressSpace - - 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 - - AvailabilityAddressSpaceIdParameter - - AvailabilityAddressSpaceIdParameter - - - None - - - - - - 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 - - AvailabilityAddressSpaceIdParameter - - AvailabilityAddressSpaceIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-availabilityaddressspace - - - - - - Get-AvailabilityConfig - Get - AvailabilityConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-AvailabilityConfig cmdlet lists the accounts that have permissions to issue proxy availability service requests on an organizational or per-user basis. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AvailabilityConfig - - Identity - - The Identity parameter specifies the availability configuration to be retrieved. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the availability configuration to be retrieved. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-availabilityconfig - - - - - - Get-CalendarDiagnosticAnalysis - Get - CalendarDiagnosticAnalysis - - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CalendarDiagnosticAnalysis - - 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. - - CalendarLog[] - - CalendarLog[] - - - None - - - 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. - - AnalysisDetailLevel - - AnalysisDetailLevel - - - None - - - 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). - - String - - String - - - None - - - OutputAs - - The OutputAs parameter specifies the output format of the command. Valid values are: - - CSV (This is the default value) - - HTML - - XML - - OutputType - - OutputType - - - None - - - - Get-CalendarDiagnosticAnalysis - - 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. - - String[] - - String[] - - - None - - - 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. - - AnalysisDetailLevel - - AnalysisDetailLevel - - - None - - - 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). - - String - - String - - - None - - - OutputAs - - The OutputAs parameter specifies the output format of the command. Valid values are: - - CSV (This is the default value) - - HTML - - XML - - OutputType - - OutputType - - - None - - - - - - 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. - - CalendarLog[] - - CalendarLog[] - - - None - - - 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. - - String[] - - String[] - - - None - - - 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. - - AnalysisDetailLevel - - AnalysisDetailLevel - - - None - - - 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). - - String - - String - - - None - - - OutputAs - - The OutputAs parameter specifies the output format of the command. Valid values are: - - CSV (This is the default value) - - HTML - - XML - - OutputType - - OutputType - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - $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 -------------------------- - 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" - - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis - - - - - - Get-CalendarDiagnosticLog - Get - CalendarDiagnosticLog - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CalendarDiagnosticLog - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 (| Set-Content -Path "C:\My Documents\Calendar Export") or substitute the output to a PowerShell variable. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - EntryId - - The EntryId parameter filters the results by entry ID. You can specify multiple values separated by commas. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String[] - - String[] - - - None - - - ItemIds - - The ItemIds parameter filters the results by item ID. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - - SwitchParameter - - - False - - - ResultSize - - This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - - Get-CalendarDiagnosticLog - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 (| Set-Content -Path "C:\My Documents\Calendar Export") or substitute the output to a PowerShell variable. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - ResultSize - - This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. - - Unlimited - - Unlimited - - - None - - - - Get-CalendarDiagnosticLog - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 (| Set-Content -Path "C:\My Documents\Calendar Export") or substitute the output to a PowerShell variable. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - ResultSize - - This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. - - Unlimited - - Unlimited - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 (| Set-Content -Path "C:\My Documents\Calendar Export") or substitute the output to a PowerShell variable. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - EntryId - - The EntryId parameter filters the results by entry ID. You can specify multiple values separated by commas. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String[] - - String[] - - - None - - - ItemIds - - The ItemIds parameter filters the results by item ID. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ResultSize - - This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticlog - - - - - - Get-CalendarDiagnosticObjects - Get - CalendarDiagnosticObjects - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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;<AdditionalDetails>`, `Client=WebServices;<AdditionalDetails>`;, 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CalendarDiagnosticObjects - - 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) - - UnifiedGroupOrUserMailboxIdParameter - - UnifiedGroupOrUserMailboxIdParameter - - - None - - - ConfigurationName - - {{ Fill ConfigurationName Description }} - - String - - String - - - None - - - CustomPropertyNames - - The CustomPropertyNames parameter returns the specified calendar item custom property in the results. For valid values, see Values for the CustomPropertyNames parameter in Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/values-for-custompropertynames-parameter). - You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - EntryId - - The EntryID parameter filters the results by the specified EntryID property value, which corresponds to the MAPI property PR_ENTRYID. - - String - - String - - - None - - - EwsId - - {{ Fill EwsId Description }} - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String[] - - String[] - - - None - - - ItemIds - - The ItemIds parameter filters the results by item ID. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - ODataId - - {{ Fill ODataId Description }} - - String - - String - - - None - - - ResultSize - - This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ShouldDecodeEnums - - {{ Fill ShouldDecodeEnums Description }} - - Boolean - - Boolean - - - None - - - ShouldFetchAttendeeCollection - - {{ Fill ShouldFetchAttendeeCollection Description }} - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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 - - String - - String - - - None - - - - - - 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) - - UnifiedGroupOrUserMailboxIdParameter - - UnifiedGroupOrUserMailboxIdParameter - - - None - - - ConfigurationName - - {{ Fill ConfigurationName Description }} - - String - - String - - - None - - - CustomPropertyNames - - The CustomPropertyNames parameter returns the specified calendar item custom property in the results. For valid values, see Values for the CustomPropertyNames parameter in Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/values-for-custompropertynames-parameter). - You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - EntryId - - The EntryID parameter filters the results by the specified EntryID property value, which corresponds to the MAPI property PR_ENTRYID. - - String - - String - - - None - - - EwsId - - {{ Fill EwsId Description }} - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String[] - - String[] - - - None - - - ItemIds - - The ItemIds parameter filters the results by item ID. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - ODataId - - {{ Fill ODataId Description }} - - String - - String - - - None - - - ResultSize - - This parameter determines the number of results returned by the cmdlet. The maximum value is 1000. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ShouldDecodeEnums - - {{ Fill ShouldDecodeEnums Description }} - - Boolean - - Boolean - - - None - - - ShouldFetchAttendeeCollection - - {{ Fill ShouldFetchAttendeeCollection Description }} - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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 - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticobjects - - - - - - Get-CalendarProcessing - Get - CalendarProcessing - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For details about the properties that are returned in the output of this cmdlet, see Set-CalendarProcessing (https://docs.microsoft.com/powershell/module/exchange/set-calendarprocessing). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CalendarProcessing - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-CalendarProcessing -Identity "Room 212" | Format-List - - This example shows the calendar processing options for the resource mailbox Room 212. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-calendarprocessing - - - - - - Get-DistributionGroup - Get - DistributionGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DistributionGroup - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-DistributionGroup - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-DistributionGroup - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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 - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-distributiongroup - - - - - - Get-DistributionGroupMember - Get - DistributionGroupMember - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If your organization has multiple Active Directory domains, you may need to run the Set-ADServerSettings cmdlet with the ViewEntireForest parameter set to $true before running the Get-DistributionGroupMember cmdlet to view the entire forest. For more information, see Example 2. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DistributionGroupMember - - 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 - - DistributionGroupMemberIdParameter - - DistributionGroupMemberIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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 - - DistributionGroupMemberIdParameter - - DistributionGroupMemberIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-distributiongroupmember - - - - - - Get-DynamicDistributionGroup - Get - DynamicDistributionGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A dynamic distribution group queries mail-enabled objects and builds the group membership based on the results. The group membership is recalculated whenever an email message is sent to the group. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DynamicDistributionGroup - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-DynamicDistributionGroup - - 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 - - DynamicGroupIdParameter - - DynamicGroupIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-DynamicDistributionGroup - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - DynamicGroupIdParameter - - DynamicGroupIdParameter - - - None - - - 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 - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroup - - - - - - Get-EligibleDistributionGroupForMigration - Get - EligibleDistributionGroupForMigration - - This cmdlet is available or 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-EligibleDistributionGroupForMigration - - 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. - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-EligibleDistributionGroupForMigration - - 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. - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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. - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-EligibleDistributionGroupForMigration -ResultSize unlimited - - This example returns a summary list of all distribution groups that can be upgraded to Microsoft 365 Groups. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-eligibledistributiongroupformigration - - - - - - Get-FederatedOrganizationIdentifier - Get - FederatedOrganizationIdentifier - - This cmdlet is available in 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://docs.microsoft.com/exchange/federation-exchange-2013-help). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-FederatedOrganizationIdentifier - - Identity - - The Identity parameter specifies the organization ID. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the organization ID. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-federatedorganizationidentifier - - - - - - Get-FederationInformation - Get - FederationInformation - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-FederationInformation - - DomainName - - The DomainName parameter specifies the domain name for which federation information is to be retrieved. - - SmtpDomain - - SmtpDomain - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - DomainName - - The DomainName parameter specifies the domain name for which federation information is to be retrieved. - - SmtpDomain - - SmtpDomain - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-FederationInformation -DomainName contoso.com - - This example gets federation information from the domain contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-federationinformation - - - - - - Get-FederationTrust - Get - FederationTrust - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-FederationTrust - - Identity - - The Identity parameter specifies a federation trust ID. If not specified, the cmdlet returns all federation trusts configured for the Exchange organization. - - FederationTrustIdParameter - - FederationTrustIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies a federation trust ID. If not specified, the cmdlet returns all federation trusts configured for the Exchange organization. - - FederationTrustIdParameter - - FederationTrustIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-FederationTrust | Format-List - - This example retrieves properties of the federation trust configured for the Exchange organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-federationtrust - - - - - - Get-Group - Get - Group - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-Group cmdlet returns no mail-related properties for distribution groups or mail-enabled security groups, and no role group-related properties for role groups. To view the object-specific properties for a group, you need to use the corresponding cmdlet based on the object type (for example, Get-DistributionGroup or Get-RoleGroup). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-Group - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-Group - - 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 - - GroupIdParameter - - GroupIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - GroupIdParameter - - GroupIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-group - - - - - - Get-IntraOrganizationConfiguration - Get - IntraOrganizationConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-IntraOrganizationConfiguration - - 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. - - OnPremisesOrganizationIdParameter - - OnPremisesOrganizationIdParameter - - - None - - - - - - 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. - - OnPremisesOrganizationIdParameter - - OnPremisesOrganizationIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-IntraOrganizationConfiguration - - This example returns the settings of the intra-organization configuration. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-intraorganizationconfiguration - - - - - - Get-IntraOrganizationConnector - Get - IntraOrganizationConnector - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-IntraOrganizationConnector - - 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 - - IntraOrganizationConnectorIdParameter - - IntraOrganizationConnectorIdParameter - - - None - - - - - - 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 - - IntraOrganizationConnectorIdParameter - - IntraOrganizationConnectorIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-intraorganizationconnector - - - - - - Get-MailboxCalendarFolder - Get - MailboxCalendarFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-MailboxCalendarFolder cmdlet retrieves information for the specified calendar folder. This information includes the calendar folder name, whether the folder is currently published or shared, the start and end range of calendar days published, the level of details published for the calendar, whether the published URL of the calendar can be searched on the web and the published URL for the calendar. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxCalendarFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - - - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxcalendarfolder - - - - - - Get-MailboxFolderPermission - Get - MailboxFolderPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxFolderPermission - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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 - - MailboxFolderUserIdParameter - - MailboxFolderUserIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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 - - MailboxFolderUserIdParameter - - MailboxFolderUserIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 3 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission - - - Add-MailboxFolderPermission - - - - Set-MailboxFolderPermission - - - - Remove-MailboxFolderPermission - - - - Get-EXOMailboxFolderPermission - - - - - - - Get-OnlineMeetingConfiguration - Get - OnlineMeetingConfiguration - - This cmdlet is available or 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OnlineMeetingConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-OnlineMeetingConfiguration -Identity carlam@fourthcoffee.com - - This example gets the Skype Meetings configuration for the specified mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-onlinemeetingconfiguration - - - - - - Get-OrganizationRelationship - Get - OrganizationRelationship - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OrganizationRelationship - - Identity - - The Identity parameter specifies the identity of the organizational relationship. You can use the following values: - - Canonical name - - GUID - - Name - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the identity of the organizational relationship. You can use the following values: - - Canonical name - - GUID - - Name - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-organizationrelationship - - - - - - Get-Place - Get - Place - - 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. You can either fetch all Places, fetch all Places of a Type using -Type filter, or a specific place using -Identity parameter. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-Place - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - ResultSize - - This parameter is reserved for internal Microsoft use. - - Unlimited - - Unlimited - - - None - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - ResultSize - - This parameter is reserved for internal Microsoft use. - - Unlimited - - Unlimited - - - None - - - Type - - The Type parameter can be used to filter the type of Places to fetch. Supported values: - - Space - - Room - - RoomList - - - Type - - String - - - None - - - Organization - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-Place -Identity "Conference Room 01" - - This example returns summary metadata for the room mailbox named Conference Room 1. - - - - -------------------------- Example 2 -------------------------- - Get-Place -Identity "Conference Room 01" | Format-List - - This example returns detailed metadata for Conference Room 1. - - - - -------------------------- Example 3 -------------------------- - Get-Place -Type "Room" - - This example returns summary metadata for all the Rooms. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-place - - - - - - Get-PlacesSettings - Get - PlacesSettings - - This cmdlet is available only in the cloud-based service. - Use the Get-PlacesSettings cmdlet to view the Places application organization settings. Note: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PlacesSettings - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-PlacesSettings - - Get-PlacesSettings | ft AllowInConnectionsLists - AllowInConnectionsLists - ----------------------- - {Default:True, OID:7faa4901-f40c-4c52-94fa-8451ce746253@6b949958-f668-45f3-b689-6ffd8c65b322:False} - AllowInConnectionsList sets Collaborator Visibility - All of the organization users can be viewed in the collaborator list by default. IT admin can set up a security group to exclude users from the list of accessible collaborators. - This example shows the Places application configuration. AllowInConnectionsLists have the organization wide Collaborators policy configuration, allowing (Default:true) most users to be added as collaborators. A group of users (OID:....:false) is taken out from the collaborators list that can be seen, bypassing the org wide setting. - - - - -------------------------- Example 2 -------------------------- - Get-PlacesSettings - - Get-PlacesSettings | ft PlacesEnabled - PlacesEnabled - ------------- - {Default:False, OID:7faa4901-f40c-4c52-94fa-8451ce746253@6b949958-f668-45f3-b689-6ffd8c65b322:True} - PlacesEnabled set Places User Enablement - All of the organization users can not access MS Places by default. IT admin can set up a security group; members for that group can access the MS Places. - This example shows the Places application configuration. PlacesEnabled have the 'Default' organization wide configuration, blocking (Default:false) most users access to Places. A group of users (OID:....:true) is allowed access to Places application, bypassing the org wide setting. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-place - - - - - - Set-PlacesSettings - Set - PlacesSettings - - This cmdlet is available only in the cloud-based service. - Use the Set-PlacesSettings cmdlet to set the Places application organization settings. Note: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-PlacesSettings - - AllowInConnectionsList - - The AllowInConnectionsList parameter specifies the list, separated by comas, of users excluded from the collaborators list in the application. For example: - - Default:true -- Most users excluded from the Collaborators list. - - OID:269e462a-d129-4dd0-a00a-7f4e78943241@7054d2bc-4dfb-4d48-95e4-a72bfac7e376:false -- Members of a group, specified by ExternalDirectoryObjectId (OID) and Tenant ID, that are excluded from the collaborators list that can be seen in the application. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - PlacesEnabled - - The PlacesEnabled parameter specifies the list, separated by comas, of users allowed to use Places application. For example: - - Default:false -- Most organization users disallowed to use Places - - OID:269e462a-d129-4dd0-a00a-7f4e78943241@7054d2bc-4dfb-4d48-95e4-a72bfac7e376:true -- Members of a group, specified by ExternalDirectoryObjectId (OID) and Tenant ID, that are allowed to use Places. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-PlacesSettings -AllowInConnectionsList Default:true,OID:269e462a-d129-4dd0-a00a-7f4e78943241@7054d2bc-4dfb-4d48-95e4-a72bfac7e376:false - - AllowInConnectionsList sets Collaborator Visibility - All of the organization users can be viewed in the collaborator list by default. IT admin can set up a security group to exclude users from the list of accessible collaborators. - This example sets the Places application configuration. AllowInConnectionsLists sets the organization wide Collaborators policy configuration, allowing (Default:true) most users to be added as collaborators. A group of users (OID:....:false) is taken out from the collaborators list that can be seen, bypassing the org wide setting. - You can use Get-PlacesSettings to check the information recently updated by the cmdlet - - - - -------------------------- Example 2 -------------------------- - Set-PlacesSettings -PlacesEnabled Default:false,OID:269e462a-d129-4dd0-a00a-7f4e78943241@7054d2bc-4dfb-4d48-95e4-a72bfac7e376:true - - PlacesEnabled set Places User Enablement - All of the organization users can not access MS Places by default. IT admin can set up a security group; members for that group can access the MS Places - This example sets the Places application configuration. PlacesEnabled sets the 'Default' organization wide configuration, blocking (Default:false) most users access to Places. A group of users (OID:....:true) is allowed access to Places application, bypassing the org wide setting. - You can use Get-PlacesSettings to check the information recently updated by the cmdlet - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-place - - - - - - Get-ResourceConfig - Get - ResourceConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ResourceConfig - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ResourceConfig - - This example returns all of the available custom room and equipment mailbox properties. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-resourceconfig - - - - - - Get-SharingPolicy - Get - SharingPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Users can only share free/busy and contact information after federation has been configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing settings for the mailbox. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SharingPolicy - - 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 - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - - - - 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 - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-sharingpolicy - - - - - - New-AvailabilityConfig - New - AvailabilityConfig - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-AvailabilityConfig - - OrgWideAccount - - The OrgWideAccount parameter specifies an account or security group that has permission to issue proxy Availability service requests on an organization-wide basis. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-availabilityconfig - - - - - - New-DistributionGroup - New - DistributionGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-DistributionGroup - - 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. - - String - - String - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 - - 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"`. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MemberUpdateType - - MemberUpdateType - - - None - - - 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. - - MemberUpdateType - - MemberUpdateType - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - GroupType - - GroupType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - 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"`. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MemberUpdateType - - MemberUpdateType - - - None - - - 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. - - MemberUpdateType - - MemberUpdateType - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - GroupType - - GroupType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-distributiongroup - - - - - - New-DynamicDistributionGroup - New - DynamicDistributionGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-DynamicDistributionGroup - - 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. - - String - - String - - - None - - - 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). - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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 following 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. - - String - - String - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DirectMembershipOnly - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-DynamicDistributionGroup - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). - - String - - String - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DirectMembershipOnly - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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). - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). - - String - - String - - - None - - - 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 following 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. - - String - - String - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DirectMembershipOnly - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dynamicdistributiongroup - - - - - - New-IntraOrganizationConnector - New - IntraOrganizationConnector - - This cmdlet is available in 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-IntraOrganizationConnector cmdlet to create an Intra-Organization connector between two on-premises Exchange forests in an organization, between an Exchange on-premises organization and an Exchange Online organization, or between two Exchange Online organizations. This connector enables feature availability and service connectivity across the organizations using a common connector and connection endpoints. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The New-IntraOrganizationConnector cmdlet is used to create a connection for 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. - For hybrid deployments between on-premises Exchange and Exchange Online organizations, the New-IntraOrganizationConnector cmdlet is used by the Hybrid Configuration wizard. Typically, the Intra-Organization connector is configured when the hybrid deployment is initially created by the wizard. We strongly recommend that you use the Hybrid Configuration wizard to create the Intra-Organization connector when configuring a hybrid deployment with an Exchange Online organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-IntraOrganizationConnector - - 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. - - String - - String - - - None - - - 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. - - Uri - - Uri - - - None - - - TargetAddressDomains - - The TargetAddressDomains parameter specifies the domain namespaces that will be used in the Intra-organization connector. These domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. - You specify multiple domain values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter enables or disabled the Intra-organization connector. The valid values for this parameter are $true or $false. The default value is $true. - When you set the value to $false, you completely stop connectivity for the specific connection. - - Boolean - - Boolean - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - Uri - - Uri - - - None - - - 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. - - String - - String - - - None - - - TargetAddressDomains - - The TargetAddressDomains parameter specifies the domain namespaces that will be used in the Intra-organization connector. These domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. - You specify multiple domain values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter enables or disabled the Intra-organization connector. The valid values for this parameter are $true or $false. The default value is $true. - When you set the value to $false, you completely stop connectivity for the specific connection. - - Boolean - - Boolean - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-intraorganizationconnector - - - - - - New-OrganizationRelationship - New - OrganizationRelationship - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Before you can create an organization relationship, you must first create a federation trust. For more information, see Federation (https://docs.microsoft.com/exchange/federation-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-OrganizationRelationship - - Name - - The Name parameter specifies the unique name of the organization relationship. The maximum length is 64 characters. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - FreeBusyAccessLevel - - FreeBusyAccessLevel - - - None - - - 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. - - GroupIdParameter - - GroupIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailTipsAccessLevel - - MailTipsAccessLevel - - - None - - - 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. - - GroupIdParameter - - GroupIdParameter - - - None - - - OrganizationContact - - The OrganizationContact parameter specifies the email address that can be used to contact the external organization (for example, administrator@fourthcoffee.com). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the unique name of the organization relationship. The maximum length is 64 characters. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - FreeBusyAccessLevel - - FreeBusyAccessLevel - - - None - - - 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. - - GroupIdParameter - - GroupIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailTipsAccessLevel - - MailTipsAccessLevel - - - None - - - 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. - - GroupIdParameter - - GroupIdParameter - - - None - - - OrganizationContact - - The OrganizationContact parameter specifies the email address that can be used to contact the external organization (for example, administrator@fourthcoffee.com). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-organizationrelationship - - - - - - New-SharingPolicy - New - SharingPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-SharingPolicy - - Name - - The Name parameter specifies the name of the new sharing policy. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Name - - The Name parameter specifies the name of the new sharing policy. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-sharingpolicy - - - - - - Remove-AvailabilityAddressSpace - Remove - AvailabilityAddressSpace - - This cmdlet is available in 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-AvailabilityAddressSpace cmdlet to remove existing availability address space objects and the associated credentials that were used to share free/busy data across Exchange organizations. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In on-premises Exchange organizations, you run the Remove-AvailabilityAddressSpace cmdlet on Exchange servers that have the Client Access server role installed. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-AvailabilityAddressSpace - - Identity - - 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 - - AvailabilityAddressSpaceIdParameter - - AvailabilityAddressSpaceIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - AvailabilityAddressSpaceIdParameter - - AvailabilityAddressSpaceIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AvailabilityAddressSpace -Identity Contoso.com - - This example removes the availability address space object named Contoso.com. - - - - -------------------------- Example 2 -------------------------- - Remove-AvailabilityAddressSpace -Identity Contoso.com -Confirm:$false - - This example immediately removes the availability address space object named Contoso.com without displaying the confirmation prompt. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-availabilityaddressspace - - - - - - Remove-AvailabilityConfig - Remove - AvailabilityConfig - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-AvailabilityConfig - - 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. - - AvailabilityConfigIdParameter - - AvailabilityConfigIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - AvailabilityConfigIdParameter - - AvailabilityConfigIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AvailabilityConfig - - This example removes the existing availability configuration. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-availabilityconfig - - - - - - Remove-CalendarEvents - Remove - CalendarEvents - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-CalendarEvents - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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). - - Int32 - - Int32 - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - ExDateTime - - ExDateTime - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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). - - Int32 - - Int32 - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - ExDateTime - - ExDateTime - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - - - Remove-DistributionGroup - Remove - DistributionGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-DistributionGroup - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DistributionGroup -Identity "Temporary Staff" - - This example removes the distribution group named Temporary Staff. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-distributiongroup - - - - - - Remove-DistributionGroupMember - Remove - DistributionGroupMember - - This cmdlet is available in 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-DistributionGroupMember cmdlet to remove a single member from distribution groups or mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can't use the Remove-DistributionGroupMember cmdlet to remove the member of a dynamic distribution group. A dynamic distribution group's membership is calculated from query results. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-DistributionGroupMember - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DistributionGroupMember -Identity "Technical Support" -Member "Jan Dryml" - - This example removes Jan Dryml from the distribution group named Technical Support. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-distributiongroupmember - - - - - - Remove-DynamicDistributionGroup - Remove - DynamicDistributionGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-DynamicDistributionGroup - - 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 - - DynamicGroupIdParameter - - DynamicGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - DynamicGroupIdParameter - - DynamicGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DynamicDistributionGroup -Identity "Test Users" - - This example deletes the dynamic distribution group named Test Users. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-dynamicdistributiongroup - - - - - - Remove-IntraOrganizationConnector - Remove - IntraOrganizationConnector - - This cmdlet is available in 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-IntraOrganizationConnector cmdlet to remove existing Intra-Organization connectors. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 <ConnectorIdentity> -Enabled $false`. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-IntraOrganizationConnector - - Identity - - 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 - - IntraOrganizationConnectorIdParameter - - IntraOrganizationConnectorIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - IntraOrganizationConnectorIdParameter - - IntraOrganizationConnectorIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-IntraOrganizationConnector "Contoso On-premises-Exchange Online" - - This example removes the existing Intra-Organization connector named "Contoso On-premises-Exchange Online". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-intraorganizationconnector - - - - - - Remove-MailboxFolderPermission - Remove - MailboxFolderPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can't use this cmdlet to selectively remove permissions from a user on a mailbox folder. The cmdlet removes all permissions that are assigned to the user on the specified folder. To modify the permissions that are assigned to the user on a mailbox folder, use the Set-MailboxFolderPermission cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MailboxFolderPermission - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - MailboxFolderUserIdParameter - - MailboxFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - ResetDelegateUserCollection - - This parameter is available only in the cloud-based service. - The ResetDelegateUserCollection switch can only be used together with -Identity parameter, and the value of Identity should be the user's primary calendar folder, for example, kim@consoto.com:\Calendar. If you run into a problem when trying to add, change, or remove delegate permissions, it is possible that the delegate information stored in the LocalFreeBusy item or the PR_FREEBUSY_ENTRYIDS has become corrupted. Including this switch will delete those files and will downgrade any existing Delegates to Editor status. You will need to grant Delegate permissions again using -SharingPermissionFlag Delegate. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - MailboxFolderUserIdParameter - - MailboxFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - ResetDelegateUserCollection - - This parameter is available only in the cloud-based service. - The ResetDelegateUserCollection switch can only be used together with -Identity parameter, and the value of Identity should be the user's primary calendar folder, for example, kim@consoto.com:\Calendar. If you run into a problem when trying to add, change, or remove delegate permissions, it is possible that the delegate information stored in the LocalFreeBusy item or the PR_FREEBUSY_ENTRYIDS has become corrupted. Including this switch will delete those files and will downgrade any existing Delegates to Editor status. You will need to grant Delegate permissions again using -SharingPermissionFlag Delegate. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 2 -------------------------- - Remove-MailboxFolderPermission -Identity kim@contoso.com:\Calendar -ResetDelegateUserCollection - - This example will clear any corrupted delegate information from Kim's mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission - - - Get-MailboxFolderPermission - - - - Set-MailboxFolderPermission - - - - Add-MailboxFolderPermission - - - - Get-EXOMailboxFolderPermission - - - - - - - Remove-OrganizationRelationship - Remove - OrganizationRelationship - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-OrganizationRelationship - - 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 - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-OrganizationRelationship -Identity Contoso - - This example removes the organization relationship Contoso using the Identity parameter. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-organizationrelationship - - - - - - Remove-SharingPolicy - Remove - SharingPolicy - - This cmdlet is available in 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-SharingPolicy cmdlet to remove a sharing policy. Before you can remove a sharing policy, you must ensure that no mailbox users are provisioned to use that policy. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-SharingPolicy - - Identity - - 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 - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-SharingPolicy Fabrikam - - This example removes the sharing policy Fabrikam. - - - - -------------------------- Example 2 -------------------------- - Remove-SharingPolicy -Identity Contoso -Confirm:$false - - This example removes the sharing policy Contoso and suppresses the confirmation that you want to remove the policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-sharingpolicy - - - - - - Set-AvailabilityConfig - Set - AvailabilityConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AvailabilityConfig - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-AvailabilityConfig -PerUserAccount <domain name of servers group in remote forest> - - 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 username and password. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-availabilityconfig - - - - - - Set-CalendarProcessing - Set - CalendarProcessing - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-CalendarProcessing - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - AllowConflicts - - The AllowConflicts parameter specifies whether to allow conflicting meeting requests. Valid values are: - - $true: Conflicts are allowed. - - $false: Conflicts aren't allowed. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 is $true). - - $false: All users can't submit in-policy requests to the resource mailbox. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - CalendarProcessingFlags - - CalendarProcessingFlags - - - None - - - 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. - - <ResourceBookingType> - - <ResourceBookingType> - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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 - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - AllowConflicts - - The AllowConflicts parameter specifies whether to allow conflicting meeting requests. Valid values are: - - $true: Conflicts are allowed. - - $false: Conflicts aren't allowed. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 is $true). - - $false: All users can't submit in-policy requests to the resource mailbox. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - CalendarProcessingFlags - - CalendarProcessingFlags - - - None - - - 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. - - <ResourceBookingType> - - <ResourceBookingType> - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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 - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 -------------------------- - $group = New-DistributionGroup "Room 221 Booking Allowed" -Update-DistributionGroupMember -Identity $group.Identity -Members karina@contoso.com,tony@contoso.com -BypassSecurityGroupManagerCheck:$true -Set-CalendarProcessing -Identity "Room 221" -AutomateProcessing AutoAccept -BookInPolicy $group.Identity -AllBookInPolicy $false - - This example rejects meeting requests from any user who isn't a member of the "Room 221 Booking Allowed" distribution group. - - - - -------------------------- Example 8 -------------------------- - Set-CalendarProcessing -Identity "Room 221" -ProcessExternalMeetingMessages $false - - This example rejects meeting requests from any user who isn't a member of the Exchange organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-calendarprocessing - - - - - - Set-DistributionGroup - Set - DistributionGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Distribution groups aren't security principals, and therefore can't be assigned permissions. However, you can assign permissions to mail-enabled security groups. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-DistributionGroup - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - 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"...}`. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MemberUpdateType - - MemberUpdateType - - - None - - - 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. - - MemberUpdateType - - MemberUpdateType - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. - The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - 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"...}`. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MemberUpdateType - - MemberUpdateType - - - None - - - 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. - - MemberUpdateType - - MemberUpdateType - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. - The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-distributiongroup - - - - - - Set-DynamicDistributionGroup - Set - DynamicDistributionGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-DynamicDistributionGroup - - 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 - - DynamicGroupIdParameter - - DynamicGroupIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - DirectMembershipOnly - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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) - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. - The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. - - SmtpAddress - - SmtpAddress - - - None - - - 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). - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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://docs.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 (for example, `500`, `$true`, `$false`, or `$null`). - - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - 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 - - DynamicGroupIdParameter - - DynamicGroupIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - DirectMembershipOnly - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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) - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. - The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. - - SmtpAddress - - SmtpAddress - - - None - - - 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). - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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://docs.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 (for example, `500`, `$true`, `$false`, or `$null`). - - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 2 -------------------------- - $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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-dynamicdistributiongroup - - - - - - Set-FederatedOrganizationIdentifier - Set - FederatedOrganizationIdentifier - - This cmdlet is available in 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-FederatedOrganizationIdentifier cmdlet to configure the federated organization identifier for the Exchange organization. - For more details, see Federation (https://docs.microsoft.com/exchange/federation-exchange-2013-help). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You must configure a federated organization identifier to create an account namespace for your Exchange organization with the Microsoft Federation Gateway and enable federation for the purpose of sharing calendars or contacts, accessing free/busy information across Exchange organizations and securing cross-premises email delivery using federated delivery. When you create a federation trust, a value for the AccountNamespace parameter is automatically created with the Microsoft Federation Gateway. The AccountNamespace parameter is a combination of a pre-defined string and the domain specified. For example, if you specify the federated domain contoso.com as the domain, "FYDIBOHF25SPDLT.contoso.com" is automatically created as the value for the AccountNamespace parameter. You can add and remove Additional domain names later by using the Add-FederatedDomain and Remove-FederatedDomain cmdlets. - You can temporarily disable federation by disabling the organization identifier. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-FederatedOrganizationIdentifier - - Identity - - The Identity parameter specifies the federated organization identifier. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - AccountNamespace - - The AccountNamespace parameter specifies the federated domain to be used to establish the organization identifier with the Microsoft Federation Gateway. - - SmtpDomain - - SmtpDomain - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - SmtpDomain - - SmtpDomain - - - None - - - DelegationFederationTrust - - The DelegationFederationTrust parameter specifies the identity of the federation trust to be used by the organization identifier. - - FederationTrustIdParameter - - FederationTrustIdParameter - - - None - - - Enabled - - The Enabled parameter specifies whether the organization identifier is enabled. Valid values include $true or $false. - Setting the parameter to $false disables federation. - - Boolean - - Boolean - - - None - - - OrganizationContact - - The OrganizationContact parameter specifies the SMTP address of the federation contact. - - SmtpAddress - - SmtpAddress - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the federated organization identifier. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - AccountNamespace - - The AccountNamespace parameter specifies the federated domain to be used to establish the organization identifier with the Microsoft Federation Gateway. - - SmtpDomain - - SmtpDomain - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpDomain - - SmtpDomain - - - None - - - DelegationFederationTrust - - The DelegationFederationTrust parameter specifies the identity of the federation trust to be used by the organization identifier. - - FederationTrustIdParameter - - FederationTrustIdParameter - - - None - - - Enabled - - The Enabled parameter specifies whether the organization identifier is enabled. Valid values include $true or $false. - Setting the parameter to $false disables federation. - - Boolean - - Boolean - - - None - - - OrganizationContact - - The OrganizationContact parameter specifies the SMTP address of the federation contact. - - SmtpAddress - - SmtpAddress - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-FederatedOrganizationIdentifier -DelegationFederationTrust "Microsoft Federation Gateway" -AccountNamespace "Contoso.com" -Enabled $true - - This example configures a federated organization identifier for the Exchange organization. - - - - -------------------------- Example 2 -------------------------- - Set-FederatedOrganizationIdentifier -Enabled $false - - This example temporarily disables federation for the Exchange organization. - - - - -------------------------- Example 3 -------------------------- - Set-FederatedOrganizationIdentifier -Enabled $true - - This example enables the organization identifier. This enables federation for the Exchange organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-federatedorganizationidentifier - - - - - - Set-Group - Set - Group - - This cmdlet is available in 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-Group cmdlet to modify group object settings. If the group is a mail-enabled security group or a distribution group, you can use the Set-DistributionGroup cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Group cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can't use the Set-Group cmdlet to modify dynamic distribution groups. To modify dynamic distribution groups, use the Set-DynamicDistributionGroup cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-Group - - Identity - - The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - GroupIdParameter - - GroupIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - This parameter is meaningful only if the group is mail-enabled. - - String - - String - - - None - - - IsHierarchicalGroup - - 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. - - Boolean - - Boolean - - - None - - - 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 - - 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"...}`. - 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. - - GeneralRecipientIdParameter[] - - GeneralRecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - SeniorityIndex - - The SeniorityIndex parameter specifies the order in which this group will display in a hierarchical address book. A group with a value of 2 will display higher in an address book than a group with a value of 1. - - Int32 - - Int32 - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - This parameter is meaningful only if the group is mail-enabled. - - String - - String - - - None - - - Universal - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - Identity - - The Identity parameter specifies the group that you want to modify. You can use any value that uniquely identifies the group. For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - GroupIdParameter - - GroupIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - This parameter is meaningful only if the group is mail-enabled. - - String - - String - - - None - - - IsHierarchicalGroup - - 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. - - Boolean - - Boolean - - - None - - - 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 - - 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"...}`. - 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. - - GeneralRecipientIdParameter[] - - GeneralRecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - SeniorityIndex - - The SeniorityIndex parameter specifies the order in which this group will display in a hierarchical address book. A group with a value of 2 will display higher in an address book than a group with a value of 1. - - Int32 - - Int32 - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - This parameter is meaningful only if the group is mail-enabled. - - String - - String - - - None - - - Universal - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-Group -Identity "Legal Department" -Universal -Notes "verified" - - This example applies the following changes to the existing global security group Legal Department: - Change the group's scope to universal. - Add a Notes parameter value of verified. - - - - -------------------------- Example 2 -------------------------- - Set-Group -Identity "Human Resources" -IsHierarchicalGroup $true -SeniorityIndex 1 - - This example specifies that the group Human Resources is a hierarchical group and will display last within its hierarchy because its index number is 1. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-group - - - - - - Set-IntraOrganizationConnector - Set - IntraOrganizationConnector - - This cmdlet is available in 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-IntraOrganizationConnector cmdlet to modify an existing Intra-Organization connector between two on-premises Exchange forests in an organization, between an on-premises Exchange organization and an Exchange Online organization or between two Exchange Online organizations. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-IntraOrganizationConnector - - Identity - - 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 - - IntraOrganizationConnectorIdParameter - - IntraOrganizationConnectorIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DiscoveryEndpoint - - The DiscoveryEndpoint parameter specifies the externally accessible URL used for the Autodiscover service for the domain configured in the IntraOrganization Connector. This parameter is automatically populated with the TargetAutodiscoverEpr value from the Get-FederationInformation cmdlet for the defined domain. - - Uri - - Uri - - - None - - - Enabled - - The Enabled parameter enables or disabled the Intra-organization connector. The valid values for this parameter are $true or $false. The default value is $true. - When you set the value to $false, you completely stop connectivity for the specific connection. - - Boolean - - Boolean - - - None - - - TargetAddressDomains - - The TargetAddressDomains parameter specifies the domain namespaces that will be used in the Intra-Organization connector. The domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - IntraOrganizationConnectorIdParameter - - IntraOrganizationConnectorIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DiscoveryEndpoint - - The DiscoveryEndpoint parameter specifies the externally accessible URL used for the Autodiscover service for the domain configured in the IntraOrganization Connector. This parameter is automatically populated with the TargetAutodiscoverEpr value from the Get-FederationInformation cmdlet for the defined domain. - - Uri - - Uri - - - None - - - Enabled - - The Enabled parameter enables or disabled the Intra-organization connector. The valid values for this parameter are $true or $false. The default value is $true. - When you set the value to $false, you completely stop connectivity for the specific connection. - - Boolean - - Boolean - - - None - - - TargetAddressDomains - - The TargetAddressDomains parameter specifies the domain namespaces that will be used in the Intra-Organization connector. The domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-IntraOrganizationConnector "MainCloudConnector" -Enabled $false - - This example disables the Intra-Organization connector named "MainCloudConnector". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-intraorganizationconnector - - - - - - Set-MailboxCalendarFolder - Set - MailboxCalendarFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxCalendarFolder - - 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` - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DetailLevel - - The DetailLevel parameter specifies the level of calendar detail that's published and available to anonymous users. Valid values are: - - AvailabilityOnly (This is the default value) - - LimitedDetails - - FullDetails - - Editor - - This parameter is meaningful only when the PublishEnabled parameter value is $true. - - DetailLevelEnumType - - DetailLevelEnumType - - - None - - - 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. - - DateRangeEnumType - - DateRangeEnumType - - - None - - - 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. - - DateRangeEnumType - - DateRangeEnumType - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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 parameter is meaningful only when the PublishEnabled parameter value is $true. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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` - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DetailLevel - - The DetailLevel parameter specifies the level of calendar detail that's published and available to anonymous users. Valid values are: - - AvailabilityOnly (This is the default value) - - LimitedDetails - - FullDetails - - Editor - - This parameter is meaningful only when the PublishEnabled parameter value is $true. - - DetailLevelEnumType - - DetailLevelEnumType - - - None - - - 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. - - DateRangeEnumType - - DateRangeEnumType - - - None - - - 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. - - DateRangeEnumType - - DateRangeEnumType - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 parameter is meaningful only when the PublishEnabled parameter value is $true. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxcalendarfolder - - - - - - Set-MailboxFolderPermission - Set - MailboxFolderPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In Exchange Online PowerShell, if you don't use the SendNotificationToUser or SharingPermissionFlags parameters, there are no changes to the functionality of the cmdlet. For example, if the user is an existing delegate, and you change their permissions to Editor without using the SendNotificationToUser or SharingPermissionFlags parameters, the user remains a delegate. But, if you use the SendNotificationToUser parameter ($true or $false), the SharingPermissionFlags parameter has the default value None, which can affect delegate access for existing users. For example, you change an existing delegate's permission to Editor, and you use SendNotificationToUser with the value $true. The user will no longer be a delegate and will only have Editor permissions to the folder. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxFolderPermission - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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 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 - - MailboxFolderAccessRight[] - - MailboxFolderAccessRight[] - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - MailboxFolderUserIdParameter - - MailboxFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - Boolean - - Boolean - - - None - - - 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. - - MailboxFolderPermissionFlags - - MailboxFolderPermissionFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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 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 - - MailboxFolderAccessRight[] - - MailboxFolderAccessRight[] - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - MailboxFolderUserIdParameter - - MailboxFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 - - Boolean - - Boolean - - - None - - - 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. - - MailboxFolderPermissionFlags - - MailboxFolderPermissionFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission - - - Get-MailboxFolderPermission - - - - Add-MailboxFolderPermission - - - - Remove-MailboxFolderPermission - - - - Get-EXOMailboxFolderPermission - - - - - - - Set-OrganizationRelationship - Set - OrganizationRelationship - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-OrganizationRelationship - - 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 - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - 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 - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - FreeBusyAccessLevel - - FreeBusyAccessLevel - - - None - - - 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. - - GroupIdParameter - - GroupIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailTipsAccessLevel - - MailTipsAccessLevel - - - None - - - 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. - - GroupIdParameter - - GroupIdParameter - - - None - - - Name - - The Name parameter specifies the unique name of the organization relationship. The maximum length is 64 characters. - - String - - String - - - None - - - OrganizationContact - - The OrganizationContact parameter specifies the email address that can be used to contact the external organization (for example, administrator@fourthcoffee.com). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - 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 - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - FreeBusyAccessLevel - - FreeBusyAccessLevel - - - None - - - 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. - - GroupIdParameter - - GroupIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailTipsAccessLevel - - MailTipsAccessLevel - - - None - - - 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. - - GroupIdParameter - - GroupIdParameter - - - None - - - Name - - The Name parameter specifies the unique name of the organization relationship. The maximum length is 64 characters. - - String - - String - - - None - - - OrganizationContact - - The OrganizationContact parameter specifies the email address that can be used to contact the external organization (for example, administrator@fourthcoffee.com). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-organizationrelationship - - - - - - Set-Place - Set - Place - - This cmdlet is available only in the cloud-based service. - Use the Set-Place cmdlet to update room mailboxes with additional metadata, which provides a better search and room suggestion experience. Note : In hybrid environments, this cmdlet doesn't work on the following properties on synchronized room mailboxes: City, CountryOrRegion, GeoCoordinates, Phone, PostalCode, State, and Street. To modify these properties on synchronized room mailboxes, use the Set-User or Set-Mailbox cmdlets in on-premises Exchange. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-Place - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - Capacity - - The Capacity parameter specifies the capacity of the room. A valid value is an integer. - - System.Int32 - - System.Int32 - - - None - - - City - - The City parameter specifies the room's city. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - CountryInfo - - CountryInfo - - - None - - - 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. - - String - - String - - - None - - - Floor - - The Floor parameter specifies the floor number that the room is on. - - System.Int32 - - System.Int32 - - - None - - - 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 ("). - - String - - String - - - None - - - 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" - - GeoCoordinates - - GeoCoordinates - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Phone - - The Phone parameter specifies the room's telephone number. - - String - - String - - - None - - - PostalCode - - The PostalCode parameter specifies the room's postal code. - - String - - String - - - None - - - State - - The State parameter specifies the room's state or province. - - String - - String - - - None - - - Street - - The Street parameter specifies the room's physical address. - - String - - String - - - None - - - 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"`. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - Capacity - - The Capacity parameter specifies the capacity of the room. A valid value is an integer. - - System.Int32 - - System.Int32 - - - None - - - City - - The City parameter specifies the room's city. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - CountryInfo - - CountryInfo - - - None - - - 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. - - String - - String - - - None - - - Floor - - The Floor parameter specifies the floor number that the room is on. - - System.Int32 - - System.Int32 - - - None - - - 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 ("). - - String - - String - - - None - - - 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" - - GeoCoordinates - - GeoCoordinates - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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/en-us/microsoftteams/rooms/). - - Boolean - - Boolean - - - None - - - Phone - - The Phone parameter specifies the room's telephone number. - - String - - String - - - None - - - PostalCode - - The PostalCode parameter specifies the room's postal code. - - String - - String - - - None - - - State - - The State parameter specifies the room's state or province. - - String - - String - - - None - - - Street - - The Street parameter specifies the room's physical address. - - String - - String - - - None - - - 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"`. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - ParentId - - Note: This feature is still experimental and will only be available for Tenants using Microsoft Places. - To link one Place with its Location Hierarchy in Microsoft Places, you must provide its Parent Type and ID. - Tenants that are onboarding Rooms and Workspaces to Microsoft Places must run this command to be able to use Microsoft Places properly. - - String - - String - - - None - - - ParentType - - The Type of the Parent in Microsoft Places currently can be one of: - - Floor - - Section - You must provide both the Type and the ID of the parent of a Room or Workspace to properly onboard it to Microsoft Places. - - ParentLocationType - - ParentLocationType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-Place -Identity "Conference Room 01" -IsWheelChairAccessible $true -AudioDeviceName PolyCom -VideoDeviceName "InFocus WXGA Projector" - - The example adds the specified metadata to the room mailbox named Conference Room 01. - - - - -------------------------- Example 2 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-place - - - - - - Set-ResourceConfig - Set - ResourceConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - After you use this cmdlet to create custom resource properties, you use the ResourceCustom parameter on the Set-Mailbox cmdlet to add one or more of those properties to a room or equipment mailbox. For more information, see the ResourceCustom parameter description in Set-Mailbox. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ResourceConfig - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-resourceconfig - - - - - - Set-SharingPolicy - Set - SharingPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Users can only share free/busy and contact information after federation has been configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing options for the mailbox. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-SharingPolicy - - 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 - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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 SharingPolicyAction 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, 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"...}`. - A domain doesn't include subdomains. You need to configure each subdomain separately. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 SharingPolicyAction 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, 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"...}`. - A domain doesn't include subdomains. You need to configure each subdomain separately. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-sharingpolicy - - - - - - Test-OrganizationRelationship - Test - OrganizationRelationship - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Test-OrganizationRelationship cmdlet doesn't include any functional tests of federated sharing features, such as accessing user free/busy information or moving mailboxes between organizations. It only verifies that the configuration will allow these features to work correctly. - Before you can test an organization relationship, you must first create an organization relationship. For more information, see Create an organization relationship (https://docs.microsoft.com/exchange/create-an-organization-relationship-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-OrganizationRelationship - - Identity - - The Identity parameter specifies the organization relationship to be tested. You can use the following values: - - Canonical name - - GUID - - Name - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the organization relationship to be tested. You can use the following values: - - Canonical name - - GUID - - Name - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-organizationrelationship - - - - - - Update-DistributionGroupMember - Update - DistributionGroupMember - - This cmdlet is available in 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-DistributionGroupMember cmdlet to replace all members of distribution groups and mail-enabled security groups. To add or remove existing group members, use the Add-DistributionGroupMember and Remove-DistributionGroupMember cmdlets. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Update-DistributionGroupMember - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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: - - 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"`. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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: - - 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"`. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Update-DistributionGroupMember -Identity "Research Reports" -Members chris@contoso.com,michelle@contoso.com,laura@contoso.com,julia@contoso.com - - This example replaces the existing members of the distribution group name Research Reports with new members. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/update-distributiongroupmember - - - - - - Upgrade-DistributionGroup - Upgrade - DistributionGroup - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Upgrade-DistributionGroup - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ActionType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - ExecutingUser - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ActionType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - ExecutingUser - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Upgrade-DistributionGroup -DlIdentities hr@contoso.com,finance@contoso.com - - This example upgrades the specified distribution groups to Microsoft 365 Groups. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/upgrade-distributiongroup - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.Management-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.Management-Help.xml deleted file mode 100644 index 84977432dad8..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.Management-Help.xml +++ /dev/null @@ -1,485 +0,0 @@ - - - - - Get-Clutter - Get - Clutter - - This cmdlet is available only in the cloud-based service. - Use the Get-Clutter cmdlet to view Clutter settings for mailboxes in your organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-Clutter - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-Clutter -Identity "Constancia Pena" - - This example returns the Clutter settings for the user Constancia Pena. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-clutter - - - - - - Get-FocusedInbox - Get - FocusedInbox - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Focused Inbox is a replacement for Clutter that separates the Inbox into the Focused and Other tabs in Outlook on the web and newer versions of Outlook. Important emails are on the Focused tab while the rest are on the Other tab. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-FocusedInbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-FocusedInbox -Identity julia@contoso.com - - This example returns the Focused Inbox configuration for the mailbox of julia@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-focusedinbox - - - - - - Set-Clutter - Set - Clutter - - This cmdlet is available only in the cloud-based service. - Use the Set-Clutter cmdlet to configure Clutter settings for mailboxes in your organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-Clutter - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-Clutter -Identity "Alexander Martinez" -Enable $false - - This example disables Clutter for the user Alexander Martinez. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-clutter - - - - - - Set-FocusedInbox - Set - FocusedInbox - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Focused Inbox is a replacement for Clutter that separates the Inbox into the Focused and Other tabs in Outlook on the web and newer versions of Outlook. Important emails are on the Focused tab while the rest are on the Other tab. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-FocusedInbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-FocusedInbox -Identity laura@contoso.com -FocusedInboxOn $false - - This example disables Focused Inbox for the mailbox of laura@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-focusedinbox - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.MediaAndDevices-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.MediaAndDevices-Help.xml deleted file mode 100644 index ef6e4bbd0257..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.MediaAndDevices-Help.xml +++ /dev/null @@ -1,22140 +0,0 @@ - - - - - Clear-ActiveSyncDevice - Clear - ActiveSyncDevice - - This cmdlet is available in 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-ActiveSyncDevice cmdlet to delete all data from a mobile device. Note : In Exchange 2013 or later, use the Clear-MobileDevice cmdlet instead. If you have scripts that use Clear-ActiveSyncDevice, update them to use Clear-MobileDevice. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Clear-ActiveSyncDevice cmdlet deletes all user data from a mobile device the next time 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Clear-ActiveSyncDevice - - Identity - - The Identity parameter specifies the identity of the device that you want to reset. - - ActiveSyncDeviceIdParameter - - ActiveSyncDeviceIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - NotificationEmailAddresses - - The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identity of the device that you want to reset. - - ActiveSyncDeviceIdParameter - - ActiveSyncDeviceIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - NotificationEmailAddresses - - The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Clear-ActiveSyncDevice -Identity WM_JeffHay - - This example clears all data from the mobile device with the identity WM_JeffHay. - - - - -------------------------- Example 2 -------------------------- - 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 -------------------------- - Clear-ActiveSyncDevice -Identity WM_TonySmith -Cancel $true - - This example cancels a previously sent Clear-ActiveSyncDevice command request for Tony Smith's mobile device. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/clear-activesyncdevice - - - - - - Clear-MobileDevice - Clear - MobileDevice - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Clear-MobileDevice - - Identity - - The Identity parameter specifies the mobile device that you want to reset. You can use any value that uniquely identifies the mobile device. For example: - - GUID - - DeviceID - - MobileDeviceIdParameter - - MobileDeviceIdParameter - - - None - - - 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 devices wipe is the only type of wipe that's used on Outlook devices. - - - SwitchParameter - - - False - - - Cancel - - The Cancel switch cancels a pending remote device wipe request. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - NotificationEmailAddresses - - The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the mobile device that you want to reset. You can use any value that uniquely identifies the mobile device. For example: - - GUID - - DeviceID - - MobileDeviceIdParameter - - MobileDeviceIdParameter - - - None - - - 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 devices wipe is the only type of wipe that's used on Outlook devices. - - SwitchParameter - - SwitchParameter - - - False - - - Cancel - - The Cancel switch cancels a pending remote device wipe request. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - NotificationEmailAddresses - - The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/clear-mobiledevice - - - - - - Disable-UMAutoAttendant - Disable - UMAutoAttendant - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-UMAutoAttendant - - Identity - - The Identity parameter specifies the identifier for the UM auto attendant that's being disabled. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identifier for the UM auto attendant that's being disabled. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-UMAutoAttendant -Identity MyUMAutoAttendant - - This example disables the UM auto attendant MyUMAutoAttendant. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-umautoattendant - - - - - - Disable-UMCallAnsweringRule - Disable - UMCallAnsweringRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-UMCallAnsweringRule - - Identity - - The Identity parameter specifies the UM call answering rule in a UM-enabled mailbox that's to be disabled. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the UM call answering rule in a UM-enabled mailbox that's to be disabled. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-umcallansweringrule - - - - - - Disable-UMIPGateway - Disable - UMIPGateway - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The status variable for a UM IP gateway can be used to enable or disable call answering destined for the IP gateway. The Disable-UMIPGateway cmdlet disables a UM IP gateway in Active Directory by modifying its status variable. After this task is completed, the UM IP gateway no longer answers incoming calls or makes outgoing calls. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-UMIPGateway - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-umipgateway - - - - - - Enable-UMAutoAttendant - Enable - UMAutoAttendant - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Enable-UMAutoAttendant cmdlet enables the UM auto attendant by modifying its status variable. When you create a UM auto attendant, it isn't enabled by default. For the auto attendant to answer incoming calls, you must first enable it. After this task is completed, the UM auto attendant answers incoming calls. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-UMAutoAttendant - - Identity - - The Identity parameter specifies the identifier for the UM auto attendant being enabled. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identifier for the UM auto attendant being enabled. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-UMAutoAttendant -Identity MyUMAutoAttendant - - This example enables the UM auto attendant MyUMAutoAttendant. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-umautoattendant - - - - - - Enable-UMCallAnsweringRule - Enable - UMCallAnsweringRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-UMCallAnsweringRule - - Identity - - The Identity parameter specifies the UM call answering rule in a UM-enabled mailbox that's to be enabled. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the UM call answering rule in a UM-enabled mailbox that's to be enabled. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-umcallansweringrule - - - - - - Enable-UMIPGateway - Enable - UMIPGateway - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-UMIPGateway - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-UMIPGateway -Identity MyUMIPGateway - - This example enables the UM IP gateway MyUMIPGateway. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-umipgateway - - - - - - Enable-UMMailbox - Enable - UMMailbox - - This cmdlet is available in 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-UMMailbox cmdlet to enable Unified Messaging (UM) for existing mailbox users. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When the mailbox is enabled for Unified Messaging, the settings from a UM mailbox policy are applied to the mailbox. After the mailbox is enabled for Unified Messaging, the user can use the UM features that are included in Microsoft Exchange. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-UMMailbox - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - UMMailboxPolicy - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - AutomaticSpeechRecognitionEnabled - - The AutomaticSpeechRecognitionEnabled parameter specifies whether to enable Automatic Speech Recognition (ASR) for the UM mailbox. Valid values are: - - $true: ASR is enabled for the mailbox. This is the default value. ASR is available only if the user's specified preferred language is installed. - - $false: ASR is disabled for the mailbox. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Extensions - - The Extensions parameter specifies the extension number for the user. Either a single extension number or an array of telephone number extensions can be specified. The user's extension must be unique to the UM dial plan. - If you don't use this parameter, the command attempts to use a default telephone number value for the user. If you're using a Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) or E.164 dial plan, you also need to use the SIPResourceIdentifier parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - NotifyEmail - - The NotifyEmail parameter specifies the email address where the Unified Messaging welcome message is sent. By default, the message is sent to the user's SMTP email address. - - String - - String - - - None - - - PilotNumber - - The PilotNumber parameter specifies the subscriber access number users can dial to gain access to their mailboxes. The default value is the subscriber access number that's specified on the UM dial plan. - - String - - String - - - None - - - PIN - - The PIN parameter specifies the value for the initial PIN that's used for the UM mailbox. The PIN is checked against the UM mailbox policy rules. The PIN value must be from 4 through 24 numeric characters. - If you don't use this parameter, a system-generated PIN is sent to the user. By default, the PIN generated by the system contains six numeric characters. - - String - - String - - - None - - - PINExpired - - 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. - - Boolean - - Boolean - - - None - - - SIPResourceIdentifier - - The SIPResourceIdentifier parameter specifies the SIP address or E.164 address for the user. This property is compared to the URI type defined on the UM dial plan. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Enable-UMMailbox - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - UMMailboxPolicy - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - AutomaticSpeechRecognitionEnabled - - The AutomaticSpeechRecognitionEnabled parameter specifies whether to enable Automatic Speech Recognition (ASR) for the UM mailbox. Valid values are: - - $true: ASR is enabled for the mailbox. This is the default value. ASR is available only if the user's specified preferred language is installed. - - $false: ASR is disabled for the mailbox. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - EnableCloudVoiceMail - - The EnableCloudVoiceMail switch specifies whether to enable the mailbox for UM in Skype for Business Online. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Extensions - - The Extensions parameter specifies the extension number for the user. Either a single extension number or an array of telephone number extensions can be specified. The user's extension must be unique to the UM dial plan. - If you don't use this parameter, the command attempts to use a default telephone number value for the user. If you're using a Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) or E.164 dial plan, you also need to use the SIPResourceIdentifier parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - NotifyEmail - - The NotifyEmail parameter specifies the email address where the Unified Messaging welcome message is sent. By default, the message is sent to the user's SMTP email address. - - String - - String - - - None - - - PilotNumber - - The PilotNumber parameter specifies the subscriber access number users can dial to gain access to their mailboxes. The default value is the subscriber access number that's specified on the UM dial plan. - - String - - String - - - None - - - PIN - - The PIN parameter specifies the value for the initial PIN that's used for the UM mailbox. The PIN is checked against the UM mailbox policy rules. The PIN value must be from 4 through 24 numeric characters. - If you don't use this parameter, a system-generated PIN is sent to the user. By default, the PIN generated by the system contains six numeric characters. - - String - - String - - - None - - - PINExpired - - 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. - - Boolean - - Boolean - - - None - - - SendWelcomeMail - - 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. - - Boolean - - Boolean - - - None - - - SIPResourceIdentifier - - The SIPResourceIdentifier parameter specifies the SIP address or E.164 address for the user. This property is compared to the URI type defined on the UM dial plan. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - UMMailboxPolicy - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - AutomaticSpeechRecognitionEnabled - - The AutomaticSpeechRecognitionEnabled parameter specifies whether to enable Automatic Speech Recognition (ASR) for the UM mailbox. Valid values are: - - $true: ASR is enabled for the mailbox. This is the default value. ASR is available only if the user's specified preferred language is installed. - - $false: ASR is disabled for the mailbox. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - EnableCloudVoiceMail - - The EnableCloudVoiceMail switch specifies whether to enable the mailbox for UM in Skype for Business Online. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Extensions - - The Extensions parameter specifies the extension number for the user. Either a single extension number or an array of telephone number extensions can be specified. The user's extension must be unique to the UM dial plan. - If you don't use this parameter, the command attempts to use a default telephone number value for the user. If you're using a Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) or E.164 dial plan, you also need to use the SIPResourceIdentifier parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - NotifyEmail - - The NotifyEmail parameter specifies the email address where the Unified Messaging welcome message is sent. By default, the message is sent to the user's SMTP email address. - - String - - String - - - None - - - PilotNumber - - The PilotNumber parameter specifies the subscriber access number users can dial to gain access to their mailboxes. The default value is the subscriber access number that's specified on the UM dial plan. - - String - - String - - - None - - - PIN - - The PIN parameter specifies the value for the initial PIN that's used for the UM mailbox. The PIN is checked against the UM mailbox policy rules. The PIN value must be from 4 through 24 numeric characters. - If you don't use this parameter, a system-generated PIN is sent to the user. By default, the PIN generated by the system contains six numeric characters. - - String - - String - - - None - - - PINExpired - - 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. - - Boolean - - Boolean - - - None - - - SendWelcomeMail - - 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. - - Boolean - - Boolean - - - None - - - SIPResourceIdentifier - - The SIPResourceIdentifier parameter specifies the SIP address or E.164 address for the user. This property is compared to the URI type defined on the UM dial plan. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Enable-UMMailbox -Identity tonysmith@contoso.com -UMMailboxPolicy MyUMMailboxPolicy -Extensions 51234 -PIN 5643892 -SIPResourceIdentifier "tonysmith@contoso.com" -PINExpired $true - - This example enables Unified Messaging on a SIP-enabled mailbox for tonysmith@contoso.com, associates the UM mailbox policy MyUMMailboxPolicy, and sets the extension number, SIP resource identifier, and PIN for the user that must be changed when the user logs on to Outlook Voice Access, and then sends an email message that contains the Unified Messaging welcome information to tonysmith@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-ummailbox - - - - - - Export-UMCallDataRecord - Export - UMCallDataRecord - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Export-UMCallDataRecord - - ClientStream - - The ClientStream parameter specifies the .NET stream to use to output for the Unified Messaging call data records. - - Stream - - Stream - - - None - - - 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. - - ExDateTime - - ExDateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - 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. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - ClientStream - - The ClientStream parameter specifies the .NET stream to use to output for the Unified Messaging call data records. - - Stream - - Stream - - - None - - - 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. - - ExDateTime - - ExDateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - 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. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/export-umcalldatarecord - - - - - - Export-UMPrompt - Export - UMPrompt - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Export-UMPrompt - - PromptFileName - - The PromptFileName parameter specifies the name of the custom prompt to export. - - String - - String - - - None - - - UMAutoAttendant - - The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Export-UMPrompt - - PromptFileName - - The PromptFileName parameter specifies the name of the custom prompt to export. - - String - - String - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - PromptFileName - - The PromptFileName parameter specifies the name of the custom prompt to export. - - String - - String - - - None - - - UMAutoAttendant - - The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 -------------------------- - $prompt = 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/export-umprompt - - - - - - Get-ActiveSyncDevice - Get - ActiveSyncDevice - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-ActiveSyncDevice cmdlet returns identification, configuration and status information for each device. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ActiveSyncDevice - - 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 - - ActiveSyncDeviceIdParameter - - ActiveSyncDeviceIdParameter - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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 - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-ActiveSyncDevice - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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 - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - ActiveSyncDeviceIdParameter - - ActiveSyncDeviceIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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 - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-activesyncdevice - - - - - - Get-ActiveSyncDeviceAccessRule - Get - ActiveSyncDeviceAccessRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ActiveSyncDeviceAccessRule - - Identity - - The Identity parameter specifies the unique identifier for the device access rule. - - ActiveSyncDeviceAccessRuleIdParameter - - ActiveSyncDeviceAccessRuleIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the unique identifier for the device access rule. - - ActiveSyncDeviceAccessRuleIdParameter - - ActiveSyncDeviceAccessRuleIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-activesyncdeviceaccessrule - - - - - - Get-ActiveSyncDeviceClass - Get - ActiveSyncDeviceClass - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use this cmdlet to view a list of mobile phones or devices by type. For example, you can return a list of all Android mobile digital devices in the organization or all Windows Phone devices in the organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ActiveSyncDeviceClass - - 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 - - ActiveSyncDeviceClassIdParameter - - ActiveSyncDeviceClassIdParameter - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can filter by the following properties: - - DeviceModel - - DeviceType - - LastUpdateTime - - String - - String - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - ActiveSyncDeviceClassIdParameter - - ActiveSyncDeviceClassIdParameter - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can filter by the following properties: - - DeviceModel - - DeviceType - - LastUpdateTime - - String - - String - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-activesyncdeviceclass - - - - - - Get-ActiveSyncDeviceStatistics - Get - ActiveSyncDeviceStatistics - - This cmdlet is available in 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 Server or Exchange Online, use the Get-MobileDeviceStatistics cmdlet instead. If you have scripts that use Get-ActiveSyncDeviceStatistics, update them to use Get-MobileDeviceStatistics. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-ActiveSyncDeviceStatistics cmdlet returns a list of statistics about each mobile device. Additionally, it allows you to retrieve logs and send those logs to a recipient for troubleshooting purposes. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ActiveSyncDeviceStatistics - - Identity - - The Identity parameter specifies the user's device ID. If the Mailbox parameter is specified, the Identity parameter is disabled. - - ActiveSyncDeviceIdParameter - - ActiveSyncDeviceIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - False - - - - Get-ActiveSyncDeviceStatistics - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the user's device ID. If the Mailbox parameter is specified, the Identity parameter is disabled. - - ActiveSyncDeviceIdParameter - - ActiveSyncDeviceIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. Note : For more information about OPath filter syntax, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-activesyncdevicestatistics - - - - - - Get-ActiveSyncMailboxPolicy - Get - ActiveSyncMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A Mobile Device mailbox policy is a group of settings that specifies how mobile devices enabled for Microsoft Exchange ActiveSync connect to the computer running Exchange. Exchange supports multiple Mobile Device mailbox policies. The Get-ActiveSyncMailboxPolicy cmdlet displays all the policy settings for the specified policy. These settings include password settings, file access settings and attachment settings. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ActiveSyncMailboxPolicy - - Identity - - The Identity parameter specifies the policy name. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the policy name. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-activesyncmailboxpolicy - - - - - - Get-ActiveSyncOrganizationSettings - Get - ActiveSyncOrganizationSettings - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ActiveSyncOrganizationSettings - - 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. - - ActiveSyncOrganizationSettingsIdParameter - - ActiveSyncOrganizationSettingsIdParameter - - - None - - - - - - 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. - - ActiveSyncOrganizationSettingsIdParameter - - ActiveSyncOrganizationSettingsIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ActiveSyncOrganizationSettings - - This example retrieves the ActiveSync organization settings. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-activesyncorganizationsettings - - - - - - Get-MobileDevice - Get - MobileDevice - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-MobileDevice cmdlet returns identification, configuration, and status information for each mobile device. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MobileDevice - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - ActiveSync - - The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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 - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - RestApi - - The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - UniversalOutlook - - The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Get-MobileDevice - - 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 - - MobileDeviceIdParameter - - MobileDeviceIdParameter - - - None - - - ActiveSync - - The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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 - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - RestApi - - The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - UniversalOutlook - - The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - ActiveSync - - The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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 - - String - - String - - - None - - - 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 - - MobileDeviceIdParameter - - MobileDeviceIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - RestApi - - The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - UniversalOutlook - - The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MobileDevice -Mailbox "TonySmith" - - This example returns all the 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mobiledevice - - - - - - Get-MobileDeviceMailboxPolicy - Get - MobileDeviceMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A Mobile Device mailbox policy is a group of settings that specifies how mobile devices connect Exchange. Exchange supports multiple mobile device mailbox policies. The Get-MobileDeviceMailboxPolicy cmdlet displays all the policy settings for the specified policy. These settings include password settings, file access settings and attachment settings. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MobileDeviceMailboxPolicy - - Identity - - The Identity parameter specifies the policy name. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the policy name. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mobiledevicemailboxpolicy - - - - - - Get-MobileDeviceStatistics - Get - MobileDeviceStatistics - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-MobileDeviceStatistics cmdlet returns a list of statistics about each mobile device. Additionally, it allows you to retrieve logs and send those logs to a recipient for troubleshooting purposes. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MobileDeviceStatistics - - 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 Mailbox parameter. - - MobileDeviceIdParameter - - MobileDeviceIdParameter - - - None - - - ActiveSync - - The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - RestApi - - The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - UniversalOutlook - - The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Get-MobileDeviceStatistics - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - ActiveSync - - The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - RestApi - - The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - UniversalOutlook - - The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - DeviceID - - You can't use this parameter with the Mailbox parameter. - - MobileDeviceIdParameter - - MobileDeviceIdParameter - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - ActiveSync - - The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - RestApi - - The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - UniversalOutlook - - The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 $_.Identity} - - This example uses the Get-CASMailbox cmdlet to determine who in the organization has an Exchange ActiveSync mobile device. For each mobile device, the Exchange ActiveSync device statistics are retrieved. Note : For more information about OPath filter syntax, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - - - -------------------------- 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 log file and sends it to the System Administrator at admin@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mobiledevicestatistics - - - - - - Get-UMAutoAttendant - Get - UMAutoAttendant - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMAutoAttendant - - 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. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies whether to display all the UM auto attendants that are associated with the UM dial plan that's specified. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - - - - 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. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies whether to display all the UM auto attendants that are associated with the UM dial plan that's specified. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-umautoattendant - - - - - - Get-UMCallAnsweringRule - Get - UMCallAnsweringRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMCallAnsweringRule - - Identity - - The Identity parameter specifies the identifier for a call answering rule being viewed. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the identifier for a call answering rule being viewed. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-umcallansweringrule - - - - - - Get-UMCallDataRecord - Get - UMCallDataRecord - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMCallDataRecord - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-UMCallDataRecord -Mailbox tony@contoso.com - - This example displays the UM call data records for the UM-enabled user Tony. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-umcalldatarecord - - - - - - Get-UMCallSummaryReport - Get - UMCallSummaryReport - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMCallSummaryReport - - 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. - - GroupBy - - GroupBy - - - None - - - 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. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - - - - 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. - - GroupBy - - GroupBy - - - None - - - 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. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-umcallsummaryreport - - - - - - Get-UMDialPlan - Get - UMDialPlan - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-UMDialPlan cmdlet displays all properties for a UM dial plan. - After this task is completed, when you specify the Identity parameter, you can view the values set. When the Get-UMDialPlan cmdlet is run, if no parameter is supplied, the cmdlet returns all UM dial plans in the Active Directory forest. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMDialPlan - - Identity - - The Identity parameter specifies the UM dial plan ID. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the UM dial plan ID. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-umdialplan - - - - - - Get-UMHuntGroup - Get - UMHuntGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMHuntGroup - - 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. - - UMHuntGroupIdParameter - - UMHuntGroupIdParameter - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan associated with a UM hunt group. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - - - - 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. - - UMHuntGroupIdParameter - - UMHuntGroupIdParameter - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan associated with a UM hunt group. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-umhuntgroup - - - - - - Get-UMIPGateway - Get - UMIPGateway - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMIPGateway - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-umipgateway - - - - - - Get-UMMailbox - Get - UMMailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMMailbox - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-UMMailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-ummailbox - - - - - - Get-UMMailboxPin - Get - UMMailboxPin - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMMailboxPin - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - IgnoreErrors - - The IgnoreErrors switch specifies whether errors that may occur when running this cmdlet are written as warnings. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - IgnoreErrors - - The IgnoreErrors switch specifies whether errors that may occur when running this cmdlet are written as warnings. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-ummailboxpin - - - - - - Get-UMMailboxPolicy - Get - UMMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UMMailboxPolicy - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies that all UM mailbox policies associated with the UM dial plan are displayed. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies that all UM mailbox policies associated with the UM dial plan are displayed. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-ummailboxpolicy - - - - - - Import-UMPrompt - Import - UMPrompt - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Import-UMPrompt - - PromptFileData - - The PromptFileData parameter specifies the byte array of the custom prompt. - - Byte[] - - Byte[] - - - None - - - PromptFileName - - The PromptFileName parameter specifies the name of the custom prompt. - - String - - String - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Import-UMPrompt - - PromptFileData - - The PromptFileData parameter specifies the byte array of the custom prompt. - - Byte[] - - Byte[] - - - None - - - PromptFileName - - The PromptFileName parameter specifies the name of the custom prompt. - - String - - String - - - None - - - UMAutoAttendant - - The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Import-UMPrompt - - PromptFileName - - The PromptFileName parameter specifies the name of the custom prompt. - - String - - String - - - None - - - 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. - - Stream - - Stream - - - None - - - UMAutoAttendant - - The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Import-UMPrompt - - PromptFileName - - The PromptFileName parameter specifies the name of the custom prompt. - - String - - String - - - None - - - 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. - - Stream - - Stream - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - PromptFileData - - The PromptFileData parameter specifies the byte array of the custom prompt. - - Byte[] - - Byte[] - - - None - - - PromptFileName - - The PromptFileName parameter specifies the name of the custom prompt. - - String - - String - - - None - - - 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. - - Stream - - Stream - - - None - - - UMAutoAttendant - - The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/import-umprompt - - - - - - New-ActiveSyncDeviceAccessRule - New - ActiveSyncDeviceAccessRule - - This cmdlet is available in 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-ActiveSyncDeviceAccessRule cmdlet to define the access levels for Exchange ActiveSync devices based on the identity of the device. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can create multiple rules that define groups of devices: Allowed devices, blocked devices and quarantined devices. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-ActiveSyncDeviceAccessRule - - AccessLevel - - 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. - - DeviceAccessLevel - - DeviceAccessLevel - - - None - - - Characteristic - - 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 - - DeviceAccessCharacteristic - - DeviceAccessCharacteristic - - - None - - - QueryString - - The QueryString parameter specifies the device identifier that's used by the rule. This parameter uses a text value that's used with Characteristic parameter value to define the device. Wildcards or partial matches aren't allowed. - You can use the Get-MobileDevice cmdlet to find the text values that you can use with the QueryString parameter. For example: Get-MobileDevice | Format-List DeviceOS,DeviceModel,DeviceType. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - AccessLevel - - 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. - - DeviceAccessLevel - - DeviceAccessLevel - - - None - - - Characteristic - - 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 - - DeviceAccessCharacteristic - - DeviceAccessCharacteristic - - - None - - - QueryString - - The QueryString parameter specifies the device identifier that's used by the rule. This parameter uses a text value that's used with Characteristic parameter value to define the device. Wildcards or partial matches aren't allowed. - You can use the Get-MobileDevice cmdlet to find the text values that you can use with the QueryString parameter. For example: Get-MobileDevice | Format-List DeviceOS,DeviceModel,DeviceType. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - New-ActiveSyncDeviceAccessRule -Characteristic UserAgent -QueryString NokiaE521/2.00()MailforExchange -AccessLevel Allow - - This example creates a device access rule that uses the UserAgent characteristic to allow access for Nokia E52-1 phones. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-activesyncdeviceaccessrule - - - - - - New-ActiveSyncMailboxPolicy - New - ActiveSyncMailboxPolicy - - This cmdlet is available in 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-ActiveSyncMailboxPolicy cmdlet to create a Microsoft Mobile Device mailbox policy object. Note : In Exchange 2013 or later, use the New-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use New-ActiveSyncMailboxPolicy, update them to use New-MobileDeviceMailboxPolicy. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The New-ActiveSyncMailboxPolicy cmdlet creates a Mobile Device mailbox policy for mailboxes accessed by mobile devices. - Some Mobile Device mailbox policy settings require the mobile device to have certain built-in features that enforce these security and device management settings. If your organization allows all devices, you must set the AllowNonProvisionableDevices parameter to $true. This allows devices that can't enforce all policy settings to synchronize with your server. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-ActiveSyncMailboxPolicy - - Name - - The Name parameter specifies the name of the policy. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - BluetoothType - - BluetoothType - - - None - - - AllowBrowser - - The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect third-party browsers. - - Boolean - - Boolean - - - None - - - AllowCamera - - The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowConsumerEmail - - The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowDesktopSync - - The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowExternalDeviceManagement - - The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the device. - - Boolean - - Boolean - - - None - - - AllowHTMLEmail - - The AllowHTMLEmail parameter specifies whether HTML email is enabled on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowInternetSharing - - 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. - - Boolean - - Boolean - - - None - - - AllowIrDA - - The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowMobileOTAUpdate - - 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. - - Boolean - - Boolean - - - None - - - AllowNonProvisionableDevices - - 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. - - Boolean - - Boolean - - - None - - - AllowPOPIMAPEmail - - The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowRemoteDesktop - - The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowSimpleDevicePassword - - 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. - - Boolean - - Boolean - - - None - - - AllowSMIMEEncryptionAlgorithmNegotiation - - 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. - - SMIMEEncryptionAlgorithmNegotiationType - - SMIMEEncryptionAlgorithmNegotiationType - - - None - - - AllowSMIMESoftCerts - - The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowStorageCard - - The AllowStorageCard parameter specifies whether the device can access information stored on a storage card. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowTextMessaging - - The AllowTextMessaging parameter specifies whether text messaging is allowed from the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowUnsignedApplications - - The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowUnsignedInstallationPackages - - The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be run on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowWiFi - - The AllowWiFi parameter specifies whether wireless Internet access is allowed on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AlphanumericDevicePasswordRequired - - The AlphanumericDevicePasswordRequired parameter specifies whether the device password must be alphanumeric. The default value is $false. - - Boolean - - Boolean - - - None - - - ApprovedApplicationList - - The ApprovedApplicationList parameter specifies a list of approved applications for the device. - - ApprovedApplicationCollection - - ApprovedApplicationCollection - - - None - - - AttachmentsEnabled - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DeviceEncryptionEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePasswordEnabled - - When set to $true, the DevicePasswordEnabled parameter specifies that the user set a password for the device. The default value is $false. - - Boolean - - Boolean - - - None - - - DevicePasswordExpiration - - The DevicePasswordExpiration parameter specifies the length of time, in days, that a password can be used. After this length of time, a new password must be created. The format of the parameter is dd.hh.mm:ss, for example, 24.00:00 = 24 hours. - - Unlimited - - Unlimited - - - None - - - DevicePasswordHistory - - The DevicePasswordHistory parameter specifies the number of previously used passwords to store. When a user creates a password, the user can't reuse a stored password that was previously used. - - Int32 - - Int32 - - - None - - - DevicePolicyRefreshInterval - - The DevicePolicyRefreshInterval parameter specifies how often the policy is sent from the server to the mobile phone - - Unlimited - - Unlimited - - - None - - - IrmEnabled - - The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - IsDefaultPolicy - - 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. - - Boolean - - Boolean - - - None - - - MaxAttachmentSize - - The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile phone. The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - MaxCalendarAgeFilter - - 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 - - CalendarAgeFilterType - - CalendarAgeFilterType - - - None - - - MaxDevicePasswordFailedAttempts - - The MaxDevicePasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the device. You can enter any number from 4 through 16. The default value is 8. - - Unlimited - - Unlimited - - - None - - - MaxEmailAgeFilter - - The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the device. - Possible values are: - - All - - OneDay - - ThreeDays - - OneWeek - - TwoWeeks - - OneMonth - - ThreeMonths - - SixMonths - - EmailAgeFilterType - - EmailAgeFilterType - - - None - - - MaxEmailBodyTruncationSize - - The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the device. The value is specified in kilobytes (KB). - - Unlimited - - Unlimited - - - None - - - MaxEmailHTMLBodyTruncationSize - - The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are synchronized to the device. The value is specified in KB. - - Unlimited - - Unlimited - - - None - - - MaxInactivityTimeDeviceLock - - The MaxInactivityTimeDeviceLock parameter specifies the length of time that the device can be inactive before the password is required to reactivate the device. You can enter any interval between 30 seconds and 1 hour. The default value is 15 minutes. The format of the parameter is hh.mm:ss, for example, 15:00 = 15 minutes. - - Unlimited - - Unlimited - - - None - - - MinDevicePasswordComplexCharacters - - The MinDevicePasswordComplexCharacters parameter specifies the minimum number of complex characters required in a device password. A complex character isn't a letter. - - Int32 - - Int32 - - - None - - - MinDevicePasswordLength - - The MinDevicePasswordLength parameter specifies the minimum number of characters in the device password. You can enter any number from 1 through 16. The maximum length a password can be is 16 characters. The default value is 4. - - Int32 - - Int32 - - - None - - - PasswordRecoveryEnabled - - 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. - - Boolean - - Boolean - - - None - - - RequireDeviceEncryption - - The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireEncryptedSMIMEMessages - - The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireEncryptionSMIMEAlgorithm - - The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. - - EncryptionSMIMEAlgorithmType - - EncryptionSMIMEAlgorithmType - - - None - - - RequireManualSyncWhenRoaming - - The RequireManualSyncWhenRoaming parameter specifies whether the device must synchronize manually while roaming. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireSignedSMIMEAlgorithm - - The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. - - SignedSMIMEAlgorithmType - - SignedSMIMEAlgorithmType - - - None - - - RequireSignedSMIMEMessages - - The RequireSignedSMIMEMessages parameter specifies whether the device must send signed S/MIME messages. - - Boolean - - Boolean - - - None - - - RequireStorageCardEncryption - - The RequireStorageCardEncryption parameter specifies whether encryption of a storage card is required. The default value is $true. - - Boolean - - Boolean - - - None - - - UnapprovedInROMApplicationList - - The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UNCAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WSSAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - - - - Name - - The Name parameter specifies the name of the policy. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - BluetoothType - - BluetoothType - - - None - - - AllowBrowser - - The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect third-party browsers. - - Boolean - - Boolean - - - None - - - AllowCamera - - The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowConsumerEmail - - The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowDesktopSync - - The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowExternalDeviceManagement - - The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the device. - - Boolean - - Boolean - - - None - - - AllowHTMLEmail - - The AllowHTMLEmail parameter specifies whether HTML email is enabled on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowInternetSharing - - 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. - - Boolean - - Boolean - - - None - - - AllowIrDA - - The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowMobileOTAUpdate - - 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. - - Boolean - - Boolean - - - None - - - AllowNonProvisionableDevices - - 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. - - Boolean - - Boolean - - - None - - - AllowPOPIMAPEmail - - The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowRemoteDesktop - - The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowSimpleDevicePassword - - 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. - - Boolean - - Boolean - - - None - - - AllowSMIMEEncryptionAlgorithmNegotiation - - 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. - - SMIMEEncryptionAlgorithmNegotiationType - - SMIMEEncryptionAlgorithmNegotiationType - - - None - - - AllowSMIMESoftCerts - - The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowStorageCard - - The AllowStorageCard parameter specifies whether the device can access information stored on a storage card. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowTextMessaging - - The AllowTextMessaging parameter specifies whether text messaging is allowed from the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowUnsignedApplications - - The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowUnsignedInstallationPackages - - The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be run on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowWiFi - - The AllowWiFi parameter specifies whether wireless Internet access is allowed on the device. The default value is $true. - - Boolean - - Boolean - - - None - - - AlphanumericDevicePasswordRequired - - The AlphanumericDevicePasswordRequired parameter specifies whether the device password must be alphanumeric. The default value is $false. - - Boolean - - Boolean - - - None - - - ApprovedApplicationList - - The ApprovedApplicationList parameter specifies a list of approved applications for the device. - - ApprovedApplicationCollection - - ApprovedApplicationCollection - - - None - - - AttachmentsEnabled - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DeviceEncryptionEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePasswordEnabled - - When set to $true, the DevicePasswordEnabled parameter specifies that the user set a password for the device. The default value is $false. - - Boolean - - Boolean - - - None - - - DevicePasswordExpiration - - The DevicePasswordExpiration parameter specifies the length of time, in days, that a password can be used. After this length of time, a new password must be created. The format of the parameter is dd.hh.mm:ss, for example, 24.00:00 = 24 hours. - - Unlimited - - Unlimited - - - None - - - DevicePasswordHistory - - The DevicePasswordHistory parameter specifies the number of previously used passwords to store. When a user creates a password, the user can't reuse a stored password that was previously used. - - Int32 - - Int32 - - - None - - - DevicePolicyRefreshInterval - - The DevicePolicyRefreshInterval parameter specifies how often the policy is sent from the server to the mobile phone - - Unlimited - - Unlimited - - - None - - - IrmEnabled - - The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - IsDefaultPolicy - - 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. - - Boolean - - Boolean - - - None - - - MaxAttachmentSize - - The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile phone. The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - MaxCalendarAgeFilter - - 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 - - CalendarAgeFilterType - - CalendarAgeFilterType - - - None - - - MaxDevicePasswordFailedAttempts - - The MaxDevicePasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the device. You can enter any number from 4 through 16. The default value is 8. - - Unlimited - - Unlimited - - - None - - - MaxEmailAgeFilter - - The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the device. - Possible values are: - - All - - OneDay - - ThreeDays - - OneWeek - - TwoWeeks - - OneMonth - - ThreeMonths - - SixMonths - - EmailAgeFilterType - - EmailAgeFilterType - - - None - - - MaxEmailBodyTruncationSize - - The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the device. The value is specified in kilobytes (KB). - - Unlimited - - Unlimited - - - None - - - MaxEmailHTMLBodyTruncationSize - - The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are synchronized to the device. The value is specified in KB. - - Unlimited - - Unlimited - - - None - - - MaxInactivityTimeDeviceLock - - The MaxInactivityTimeDeviceLock parameter specifies the length of time that the device can be inactive before the password is required to reactivate the device. You can enter any interval between 30 seconds and 1 hour. The default value is 15 minutes. The format of the parameter is hh.mm:ss, for example, 15:00 = 15 minutes. - - Unlimited - - Unlimited - - - None - - - MinDevicePasswordComplexCharacters - - The MinDevicePasswordComplexCharacters parameter specifies the minimum number of complex characters required in a device password. A complex character isn't a letter. - - Int32 - - Int32 - - - None - - - MinDevicePasswordLength - - The MinDevicePasswordLength parameter specifies the minimum number of characters in the device password. You can enter any number from 1 through 16. The maximum length a password can be is 16 characters. The default value is 4. - - Int32 - - Int32 - - - None - - - PasswordRecoveryEnabled - - 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. - - Boolean - - Boolean - - - None - - - RequireDeviceEncryption - - The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireEncryptedSMIMEMessages - - The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireEncryptionSMIMEAlgorithm - - The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. - - EncryptionSMIMEAlgorithmType - - EncryptionSMIMEAlgorithmType - - - None - - - RequireManualSyncWhenRoaming - - The RequireManualSyncWhenRoaming parameter specifies whether the device must synchronize manually while roaming. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireSignedSMIMEAlgorithm - - The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. - - SignedSMIMEAlgorithmType - - SignedSMIMEAlgorithmType - - - None - - - RequireSignedSMIMEMessages - - The RequireSignedSMIMEMessages parameter specifies whether the device must send signed S/MIME messages. - - Boolean - - Boolean - - - None - - - RequireStorageCardEncryption - - The RequireStorageCardEncryption parameter specifies whether encryption of a storage card is required. The default value is $true. - - Boolean - - Boolean - - - None - - - UnapprovedInROMApplicationList - - The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UNCAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WSSAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - New-ActiveSyncMailboxPolicy -Name:"Contoso" -DevicePasswordEnabled:$true -AlphanumericDevicePasswordRequired:$true -PasswordRecoveryEnabled:$true -MinDevicePasswordComplexCharacters:3 -IsDefault:$true -DevicePasswordHistory:10 - - This example creates the Mobile Device mailbox policy Contoso that has several preconfigured values. This policy is configured to be the default policy for the organization. The default policy will be assigned to all new users. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-activesyncmailboxpolicy - - - - - - New-MobileDeviceMailboxPolicy - New - MobileDeviceMailboxPolicy - - This cmdlet is available in 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-MobileDeviceMailboxPolicy cmdlet to create mobile device mailbox policies. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Mobile device mailbox policies define settings for mobile devices that are used to access mailboxes in your organization. The default mobile device mailbox policy is applied to all new mailboxes that you create. You can assign a mobile device mailbox policy to existing mailboxes by using the Set-CASMailbox cmdlet, or by editing the mailbox properties in the Exchange admin center (EAC). - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MobileDeviceMailboxPolicy - - Name - - 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. - - String - - String - - - None - - - AllowApplePushNotifications - - 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. - - Boolean - - Boolean - - - None - - - 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. - - BluetoothType - - BluetoothType - - - None - - - AllowBrowser - - The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect third-party browsers. - - Boolean - - Boolean - - - None - - - AllowCamera - - 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. - - Boolean - - Boolean - - - None - - - AllowConsumerEmail - - The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using third-party mobile device email programs. - - Boolean - - Boolean - - - None - - - AllowDesktopSync - - 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. - - Boolean - - Boolean - - - None - - - AllowExternalDeviceManagement - - 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. - - Boolean - - Boolean - - - None - - - AllowGooglePushNotifications - - 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. - - Boolean - - Boolean - - - None - - - AllowHTMLEmail - - 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. - - Boolean - - Boolean - - - None - - - AllowInternetSharing - - 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. - - Boolean - - Boolean - - - None - - - AllowIrDA - - 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. - - Boolean - - Boolean - - - None - - - AllowMicrosoftPushNotifications - - 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. - - Boolean - - Boolean - - - None - - - AllowMobileOTAUpdate - - 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. - - Boolean - - Boolean - - - None - - - AllowNonProvisionableDevices - - The AllowNonProvisionableDevices parameter specifies whether all mobile devices can synchronize with Exchange. Valid input for this parameter is $true or $false. The default value is $true. - When set to $true, this parameter enables all mobile devices to synchronize with Exchange, regardless of whether the device can enforce all settings that are defined by the policy. This also includes mobile devices managed by a separate device management system. When set to $false, this parameter blocks mobile devices that aren't provisioned from synchronizing with Exchange. - - Boolean - - Boolean - - - None - - - AllowPOPIMAPEmail - - The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by third-party email programs. - - Boolean - - Boolean - - - None - - - AllowRemoteDesktop - - 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. - - Boolean - - Boolean - - - None - - - AllowSimplePassword - - 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. - - Boolean - - Boolean - - - None - - - AllowSMIMEEncryptionAlgorithmNegotiation - - 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. - - SMIMEEncryptionAlgorithmNegotiationType - - SMIMEEncryptionAlgorithmNegotiationType - - - None - - - AllowSMIMESoftCerts - - 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. - - Boolean - - Boolean - - - None - - - AllowStorageCard - - 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. - - Boolean - - Boolean - - - None - - - AllowTextMessaging - - 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. - - Boolean - - Boolean - - - None - - - AllowUnsignedApplications - - 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. - - Boolean - - Boolean - - - None - - - AllowUnsignedInstallationPackages - - 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. - - Boolean - - Boolean - - - None - - - AllowWiFi - - 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. - - Boolean - - Boolean - - - None - - - AlphanumericPasswordRequired - - 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. - - Boolean - - Boolean - - - None - - - ApprovedApplicationList - - The ApprovedApplicationList parameter specifies a configured list of approved applications for the device. - - ApprovedApplicationCollection - - ApprovedApplicationCollection - - - None - - - AttachmentsEnabled - - The AttachmentsEnabled parameter specifies whether attachments can be downloaded on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. - When set to $false, this parameter blocks the user from downloading attachments on the mobile device. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DeviceEncryptionEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePolicyRefreshInterval - - The DevicePolicyRefreshInterval parameter specifies how often the policy is sent to the mobile device. - To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - IrmEnabled - - 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. - - Boolean - - Boolean - - - None - - - IsDefault - - The IsDefault parameter specifies whether this policy is the default mobile device mailbox policy. Valid input for this parameter is $true or $false. The default value for the built-in mobile device mailbox policy named Default is $true. The default value for new mobile device mailbox policies that you create is $false. - There can be only one default policy. If another policy is currently set as the default, and you set this parameter to $true, this policy becomes the default policy. The value of this parameter on the other policy is automatically changed to $false, and that policy is no longer the default policy. - - Boolean - - Boolean - - - None - - - MaxAttachmentSize - - The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile device. Valid input for this parameter is a size value between 0 and 2147482624 bytes (approximately 2 GB), or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4096 or 4KB. - 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 - - Unlimited - - Unlimited - - - None - - - MaxCalendarAgeFilter - - 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. - - CalendarAgeFilterType - - CalendarAgeFilterType - - - None - - - MaxEmailAgeFilter - - 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. - - EmailAgeFilterType - - EmailAgeFilterType - - - None - - - MaxEmailBodyTruncationSize - - The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. - - Unlimited - - Unlimited - - - None - - - MaxEmailHTMLBodyTruncationSize - - The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. - - Unlimited - - Unlimited - - - None - - - MaxInactivityTimeLock - - 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. - - Unlimited - - Unlimited - - - None - - - MaxPasswordFailedAttempts - - The MaxPasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile device. - You can enter any number from 4 through 16 or the value Unlimited. The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - MinPasswordComplexCharacters - - 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. - For Windows Phone 8 devices, the value specifies the number of character sets that are required in the password. For example, the value 3 requires at least one character from any three of the character sets. - 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. - - Int32 - - Int32 - - - None - - - MinPasswordLength - - 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. - - Int32 - - Int32 - - - None - - - PasswordEnabled - - The PasswordEnabled parameter specifies whether a password is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. - When set to $true, this parameter requires the user to set a password on the mobile device. - - Boolean - - Boolean - - - None - - - PasswordExpiration - - 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 - - Unlimited - - Unlimited - - - None - - - PasswordHistory - - The PasswordHistory parameter specifies the number of unique new passwords that need to be created on the mobile device before an old password can be reused. - You can enter any number from 0 through 50. The default value is 0. - - Int32 - - Int32 - - - None - - - PasswordRecoveryEnabled - - The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile device is stored in Exchange. Valid input for this parameter is $true or $false. The default value is $false. - When set to $true, this parameter enables you to store the recovery password for the mobile device in Exchange. The recovery password can be viewed from Outlook on the web or the Exchange admin center. - - Boolean - - Boolean - - - None - - - RequireDeviceEncryption - - 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. - - Boolean - - Boolean - - - None - - - RequireEncryptedSMIMEMessages - - 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. - - Boolean - - Boolean - - - None - - - RequireEncryptionSMIMEAlgorithm - - 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. - - EncryptionSMIMEAlgorithmType - - EncryptionSMIMEAlgorithmType - - - None - - - RequireManualSyncWhenRoaming - - 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. - - Boolean - - Boolean - - - None - - - RequireSignedSMIMEAlgorithm - - The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to sign S/MIME messages on the mobile device. - Valid values for this parameter are SHA1 or MD5. The default value is SHA1. - - SignedSMIMEAlgorithmType - - SignedSMIMEAlgorithmType - - - None - - - RequireSignedSMIMEMessages - - 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. - - Boolean - - Boolean - - - None - - - RequireStorageCardEncryption - - The RequireStorageCardEncryption parameter specifies whether storage card encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. - Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. - - Boolean - - Boolean - - - None - - - UnapprovedInROMApplicationList - - The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM on the mobile device. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UNCAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WSSAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - - - - Name - - 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. - - String - - String - - - None - - - AllowApplePushNotifications - - 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. - - Boolean - - Boolean - - - None - - - 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. - - BluetoothType - - BluetoothType - - - None - - - AllowBrowser - - The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect third-party browsers. - - Boolean - - Boolean - - - None - - - AllowCamera - - 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. - - Boolean - - Boolean - - - None - - - AllowConsumerEmail - - The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using third-party mobile device email programs. - - Boolean - - Boolean - - - None - - - AllowDesktopSync - - 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. - - Boolean - - Boolean - - - None - - - AllowExternalDeviceManagement - - 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. - - Boolean - - Boolean - - - None - - - AllowGooglePushNotifications - - 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. - - Boolean - - Boolean - - - None - - - AllowHTMLEmail - - 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. - - Boolean - - Boolean - - - None - - - AllowInternetSharing - - 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. - - Boolean - - Boolean - - - None - - - AllowIrDA - - 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. - - Boolean - - Boolean - - - None - - - AllowMicrosoftPushNotifications - - 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. - - Boolean - - Boolean - - - None - - - AllowMobileOTAUpdate - - 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. - - Boolean - - Boolean - - - None - - - AllowNonProvisionableDevices - - The AllowNonProvisionableDevices parameter specifies whether all mobile devices can synchronize with Exchange. Valid input for this parameter is $true or $false. The default value is $true. - When set to $true, this parameter enables all mobile devices to synchronize with Exchange, regardless of whether the device can enforce all settings that are defined by the policy. This also includes mobile devices managed by a separate device management system. When set to $false, this parameter blocks mobile devices that aren't provisioned from synchronizing with Exchange. - - Boolean - - Boolean - - - None - - - AllowPOPIMAPEmail - - The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by third-party email programs. - - Boolean - - Boolean - - - None - - - AllowRemoteDesktop - - 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. - - Boolean - - Boolean - - - None - - - AllowSimplePassword - - 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. - - Boolean - - Boolean - - - None - - - AllowSMIMEEncryptionAlgorithmNegotiation - - 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. - - SMIMEEncryptionAlgorithmNegotiationType - - SMIMEEncryptionAlgorithmNegotiationType - - - None - - - AllowSMIMESoftCerts - - 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. - - Boolean - - Boolean - - - None - - - AllowStorageCard - - 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. - - Boolean - - Boolean - - - None - - - AllowTextMessaging - - 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. - - Boolean - - Boolean - - - None - - - AllowUnsignedApplications - - 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. - - Boolean - - Boolean - - - None - - - AllowUnsignedInstallationPackages - - 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. - - Boolean - - Boolean - - - None - - - AllowWiFi - - 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. - - Boolean - - Boolean - - - None - - - AlphanumericPasswordRequired - - 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. - - Boolean - - Boolean - - - None - - - ApprovedApplicationList - - The ApprovedApplicationList parameter specifies a configured list of approved applications for the device. - - ApprovedApplicationCollection - - ApprovedApplicationCollection - - - None - - - AttachmentsEnabled - - The AttachmentsEnabled parameter specifies whether attachments can be downloaded on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. - When set to $false, this parameter blocks the user from downloading attachments on the mobile device. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DeviceEncryptionEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePolicyRefreshInterval - - The DevicePolicyRefreshInterval parameter specifies how often the policy is sent to the mobile device. - To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - IrmEnabled - - 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. - - Boolean - - Boolean - - - None - - - IsDefault - - The IsDefault parameter specifies whether this policy is the default mobile device mailbox policy. Valid input for this parameter is $true or $false. The default value for the built-in mobile device mailbox policy named Default is $true. The default value for new mobile device mailbox policies that you create is $false. - There can be only one default policy. If another policy is currently set as the default, and you set this parameter to $true, this policy becomes the default policy. The value of this parameter on the other policy is automatically changed to $false, and that policy is no longer the default policy. - - Boolean - - Boolean - - - None - - - MaxAttachmentSize - - The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile device. Valid input for this parameter is a size value between 0 and 2147482624 bytes (approximately 2 GB), or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4096 or 4KB. - 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 - - Unlimited - - Unlimited - - - None - - - MaxCalendarAgeFilter - - 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. - - CalendarAgeFilterType - - CalendarAgeFilterType - - - None - - - MaxEmailAgeFilter - - 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. - - EmailAgeFilterType - - EmailAgeFilterType - - - None - - - MaxEmailBodyTruncationSize - - The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. - - Unlimited - - Unlimited - - - None - - - MaxEmailHTMLBodyTruncationSize - - The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. - - Unlimited - - Unlimited - - - None - - - MaxInactivityTimeLock - - 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. - - Unlimited - - Unlimited - - - None - - - MaxPasswordFailedAttempts - - The MaxPasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile device. - You can enter any number from 4 through 16 or the value Unlimited. The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - MinPasswordComplexCharacters - - 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. - For Windows Phone 8 devices, the value specifies the number of character sets that are required in the password. For example, the value 3 requires at least one character from any three of the character sets. - 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. - - Int32 - - Int32 - - - None - - - MinPasswordLength - - 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. - - Int32 - - Int32 - - - None - - - PasswordEnabled - - The PasswordEnabled parameter specifies whether a password is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. - When set to $true, this parameter requires the user to set a password on the mobile device. - - Boolean - - Boolean - - - None - - - PasswordExpiration - - 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 - - Unlimited - - Unlimited - - - None - - - PasswordHistory - - The PasswordHistory parameter specifies the number of unique new passwords that need to be created on the mobile device before an old password can be reused. - You can enter any number from 0 through 50. The default value is 0. - - Int32 - - Int32 - - - None - - - PasswordRecoveryEnabled - - The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile device is stored in Exchange. Valid input for this parameter is $true or $false. The default value is $false. - When set to $true, this parameter enables you to store the recovery password for the mobile device in Exchange. The recovery password can be viewed from Outlook on the web or the Exchange admin center. - - Boolean - - Boolean - - - None - - - RequireDeviceEncryption - - 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. - - Boolean - - Boolean - - - None - - - RequireEncryptedSMIMEMessages - - 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. - - Boolean - - Boolean - - - None - - - RequireEncryptionSMIMEAlgorithm - - 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. - - EncryptionSMIMEAlgorithmType - - EncryptionSMIMEAlgorithmType - - - None - - - RequireManualSyncWhenRoaming - - 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. - - Boolean - - Boolean - - - None - - - RequireSignedSMIMEAlgorithm - - The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to sign S/MIME messages on the mobile device. - Valid values for this parameter are SHA1 or MD5. The default value is SHA1. - - SignedSMIMEAlgorithmType - - SignedSMIMEAlgorithmType - - - None - - - RequireSignedSMIMEMessages - - 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. - - Boolean - - Boolean - - - None - - - RequireStorageCardEncryption - - The RequireStorageCardEncryption parameter specifies whether storage card encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. - Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. - - Boolean - - Boolean - - - None - - - UnapprovedInROMApplicationList - - The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM on the mobile device. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UNCAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WSSAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - New-MobileDeviceMailboxPolicy -Name "Contoso Policy" -PasswordEnabled $true -AlphanumericPasswordRequired $true -PasswordRecoveryEnabled $true -MinPasswordComplexCharacters 3 -IsDefault $true -PasswordHistory 10 - - This example creates the mobile device mailbox policy Contoso Policy that has several preconfigured values. This policy is configured to be the default policy for the organization. The default policy is assigned to all new users. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mobiledevicemailboxpolicy - - - - - - New-UMAutoAttendant - New - UMAutoAttendant - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-UMAutoAttendant - - 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. - - String - - String - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan identifier for the UM dial plan to be associated with this UM auto attendant. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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) - - StatusEnum - - StatusEnum - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan identifier for the UM dial plan to be associated with this UM auto attendant. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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) - - StatusEnum - - StatusEnum - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-umautoattendant - - - - - - New-UMCallAnsweringRule - New - UMCallAnsweringRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-UMCallAnsweringRule - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - CallersCanInterruptGreeting - - The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. - - Boolean - - Boolean - - - None - - - CheckAutomaticReplies - - The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - TimeOfDay - - TimeOfDay - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - CallersCanInterruptGreeting - - The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. - - Boolean - - Boolean - - - None - - - CheckAutomaticReplies - - The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - TimeOfDay - - TimeOfDay - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-umcallansweringrule - - - - - - New-UMDialPlan - New - UMDialPlan - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-UMDialPlan - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - UMLanguage - - UMLanguage - - - None - - - FaxEnabled - - The FaxEnabled parameter specifies whether the Mailbox servers associated with the dial plan answer and process incoming fax calls. The default is $true. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - URIType - - The URIType parameter specifies the URI type to be sent and received with SIP messages from the Private Branch eXchange (PBX). - - UMURIType - - UMURIType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - UMLanguage - - UMLanguage - - - None - - - FaxEnabled - - The FaxEnabled parameter specifies whether the Mailbox servers associated with the dial plan answer and process incoming fax calls. The default is $true. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - URIType - - The URIType parameter specifies the URI type to be sent and received with SIP messages from the Private Branch eXchange (PBX). - - UMURIType - - UMURIType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-umdialplan - - - - - - New-UMHuntGroup - New - UMHuntGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-UMHuntGroup - - 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. - - String - - String - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan used with the UM hunt group. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - UMIPGateway - - The UMIPGateway parameter specifies the UM IP gateway to be associated with the UM hunt group. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan used with the UM hunt group. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - UMIPGateway - - The UMIPGateway parameter specifies the UM IP gateway to be associated with the UM hunt group. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-umhuntgroup - - - - - - New-UMMailboxPolicy - New - UMMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-UMMailboxPolicy - - 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. - - String - - String - - - None - - - 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. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-UMMailboxPolicy -Name MyUMMailboxPolicy -UMDialPlan MyUMDialPlan - - This example creates the UM mailbox policy MyUMMailboxPolicy associated with the UM dial plan MyUMDialPlan. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-ummailboxpolicy - - - - - - Remove-ActiveSyncDevice - Remove - ActiveSyncDevice - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Remove-ActiveSyncDevice cmdlet is useful for removing mobile devices that no longer synchronize successfully with the server. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ActiveSyncDevice - - Identity - - The Identity parameter uniquely identifies the specific device partnership to be removed. - - ActiveSyncDeviceIdParameter - - ActiveSyncDeviceIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter uniquely identifies the specific device partnership to be removed. - - ActiveSyncDeviceIdParameter - - ActiveSyncDeviceIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-activesyncdevice - - - - - - Remove-ActiveSyncDeviceAccessRule - Remove - ActiveSyncDeviceAccessRule - - This cmdlet is available in 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-ActiveSyncDeviceAccessRule cmdlet to remove any existing device access rule. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ActiveSyncDeviceAccessRule - - Identity - - The Identity parameter specifies the identity of the device access rule. - - ActiveSyncDeviceAccessRuleIdParameter - - ActiveSyncDeviceAccessRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identity of the device access rule. - - ActiveSyncDeviceAccessRuleIdParameter - - ActiveSyncDeviceAccessRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ActiveSyncDeviceAccessRule | Remove-ActiveSyncDeviceAccessRule - - This example removes all device access rules. - - - - -------------------------- Example 2 -------------------------- - Get-ActiveSyncDeviceAccessRule | where {$_.Name -like 'Contoso*'} | Remove-ActiveSyncDeviceAccessRule - - This example removes all device access rules that have a name that starts with Contoso. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-activesyncdeviceaccessrule - - - - - - Remove-ActiveSyncMailboxPolicy - Remove - ActiveSyncMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A mobile device mailbox policy is a group of settings that specifies how mobile phones connect to Exchange. Exchange supports multiple mobile device mailbox policies. If any users are assigned to the policy when you attempt to remove it, the command fails. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ActiveSyncMailboxPolicy - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-activesyncmailboxpolicy - - - - - - Remove-MobileDevice - Remove - MobileDevice - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Remove-MobileDevice cmdlet is useful for removing mobile devices that no longer synchronize successfully with the server. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MobileDevice - - Identity - - The Identity parameter specifies the mobile device partnership that you want to remove. You can use any value that uniquely identifies the mobile device. For example: - - GUID - - DeviceID - - MobileDeviceIdParameter - - MobileDeviceIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the mobile device partnership that you want to remove. You can use any value that uniquely identifies the mobile device. For example: - - GUID - - DeviceID - - MobileDeviceIdParameter - - MobileDeviceIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mobiledevice - - - - - - Remove-MobileDeviceMailboxPolicy - Remove - MobileDeviceMailboxPolicy - - This cmdlet is available in 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-MobileDeviceMailboxPolicy cmdlet to remove mobile device mailbox policies from Exchange servers. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A Mobile Device mailbox policy is a group of settings that specifies how mobile phones connect to Exchange. Exchange supports multiple mobile device mailbox policies. The Remove-MobileDeviceMailboxPolicy cmdlet removes a specific mobile device mailbox policy. If any users are assigned to the policy when you remove it, the Remove-MobileDeviceMailboxPolicy cmdlet fails. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MobileDeviceMailboxPolicy - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MobileDeviceMailboxPolicy -Identity SalesPolicy - - This example removes the mobile device mailbox policy SalesPolicy. - - - - -------------------------- Example 2 -------------------------- - Remove-MobileDeviceMailboxPolicy -Identity Engineering -Confirm:$false - - This example removes the mobile device mailbox policy named Engineering and hides the confirmation prompt. - - - - -------------------------- Example 3 -------------------------- - Remove-MobileDeviceMailboxPolicy -Identity Management -Force - - This example removes the mobile device mailbox policy named Management and bypasses any warning or error messages. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mobiledevicemailboxpolicy - - - - - - Remove-UMAutoAttendant - Remove - UMAutoAttendant - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-UMAutoAttendant - - 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. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-UMAutoAttendant -Identity MyUMAutoAttendant - - This example deletes the UM auto attendant MyUMAutoAttendant. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-umautoattendant - - - - - - Remove-UMCallAnsweringRule - Remove - UMCallAnsweringRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-UMCallAnsweringRule - - Identity - - The Identity parameter specifies the identifier for a call answering rule being removed. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identifier for a call answering rule being removed. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-umcallansweringrule - - - - - - Remove-UMDialPlan - Remove - UMDialPlan - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-UMDialPlan - - 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. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-UMDialPlan -Identity MyUMDialPlan - - This example deletes the existing UM dial plan MyUMDialPlan. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-umdialplan - - - - - - Remove-UMHuntGroup - Remove - UMHuntGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-UMHuntGroup - - 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. - - UMHuntGroupIdParameter - - UMHuntGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - UMHuntGroupIdParameter - - UMHuntGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-UMHuntGroup -Identity MyUMHuntGroup - - This example deletes the UM hunt group MyUMHuntGroup. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-umhuntgroup - - - - - - Remove-UMIPGateway - Remove - UMIPGateway - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-UMIPGateway - - Identity - - The Identity parameter specifies the identifier for the UM IP gateway being deleted. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identifier for the UM IP gateway being deleted. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-UMIPGateway -Identity MyUMIPGateway - - This example deletes the UM IP gateway MyUMIPGateway. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-umipgateway - - - - - - Remove-UMMailboxPolicy - Remove - UMMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-UMMailboxPolicy - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-UMMailboxPolicy -Identity MyUMMailboxPolicy - - This example deletes the UM mailbox policy MyUMMailboxPolicy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-ummailboxpolicy - - - - - - Set-ActiveSyncDeviceAccessRule - Set - ActiveSyncDeviceAccessRule - - This cmdlet is available in 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-ActiveSyncDeviceAccessRule cmdlet to set the level of access for the rule. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ActiveSyncDeviceAccessRule - - Identity - - The Identity parameter specifies the identity of the device access rule. - - ActiveSyncDeviceAccessRuleIdParameter - - ActiveSyncDeviceAccessRuleIdParameter - - - None - - - AccessLevel - - The AccessLevel parameter specifies whether the devices are allowed, blocked or quarantined. - - DeviceAccessLevel - - DeviceAccessLevel - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identity of the device access rule. - - ActiveSyncDeviceAccessRuleIdParameter - - ActiveSyncDeviceAccessRuleIdParameter - - - None - - - AccessLevel - - The AccessLevel parameter specifies whether the devices are allowed, blocked or quarantined. - - DeviceAccessLevel - - DeviceAccessLevel - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Get-ActiveSyncDeviceAccessRule | Where {$_.AccessLevel -eq 'Allow'} | Set-ActiveSyncDeviceAccessRule -AccessLevel Quarantine - - This example changes the organization's device access rule so that all devices explicitly allowed to access Microsoft Exchange ActiveSync are quarantined. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-activesyncdeviceaccessrule - - - - - - Set-ActiveSyncMailboxPolicy - Set - ActiveSyncMailboxPolicy - - This cmdlet is available in 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-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-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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - With the Set-ActiveSyncMailboxPolicy cmdlet, you can set each parameter in a mailbox policy. - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ActiveSyncMailboxPolicy - - Identity - - The Identity parameter specifies the Mobile Device mailbox policy. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - AllowApplePushNotifications - - This parameter is available only in the cloud-based service. - The AllowApplePushNotifications parameter specifies whether push notifications are allowed to Apple mobile devices. - - Boolean - - Boolean - - - None - - - 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. - - BluetoothType - - BluetoothType - - - None - - - AllowBrowser - - The AllowBrowser parameter indicates whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect third-party browsers. - - Boolean - - Boolean - - - None - - - AllowCamera - - The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowConsumerEmail - - The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the mobile phone. The default value is $true. This parameter doesn't control access to emails using third-party mobile phone email programs. - - Boolean - - Boolean - - - None - - - AllowDesktopSync - - The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowExternalDeviceManagement - - The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile phone. - - Boolean - - Boolean - - - None - - - AllowHTMLEmail - - 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. - - Boolean - - Boolean - - - None - - - AllowInternetSharing - - 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. - - Boolean - - Boolean - - - None - - - AllowIrDA - - The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowMobileOTAUpdate - - The AllowMobileOTAUpdate parameter specifies whether the Exchange ActiveSync mailbox policy can be sent to the mobile phone over a cellular data connection. - - Boolean - - Boolean - - - None - - - AllowNonProvisionableDevices - - 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. - - Boolean - - Boolean - - - None - - - AllowPOPIMAPEmail - - The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile phone. The default value is $true. This parameter doesn't control access by third-party email programs. - - Boolean - - Boolean - - - None - - - AllowRemoteDesktop - - The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowSimpleDevicePassword - - 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. - - Boolean - - Boolean - - - None - - - AllowSMIMEEncryptionAlgorithmNegotiation - - 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. - - SMIMEEncryptionAlgorithmNegotiationType - - SMIMEEncryptionAlgorithmNegotiationType - - - None - - - AllowSMIMESoftCerts - - The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowStorageCard - - The AllowStorageCard parameter specifies whether the mobile phone can access information stored on a storage card. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowTextMessaging - - The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowUnsignedApplications - - The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowUnsignedInstallationPackages - - The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be executed on the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowWiFi - - The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AlphanumericDevicePasswordRequired - - The AlphanumericDevicePasswordRequired parameter specifies whether the password for the mobile phone must be alphanumeric. The default value is $false. - - Boolean - - Boolean - - - None - - - ApprovedApplicationList - - The ApprovedApplicationList parameter specifies a list of approved applications for the mobile phone. - - ApprovedApplicationCollection - - ApprovedApplicationCollection - - - None - - - AttachmentsEnabled - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DeviceEncryptionEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePasswordEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePasswordExpiration - - The DevicePasswordExpiration parameter specifies the length of time, in days, that a password can be used. After this length of time, a new password must be created. The format of the parameter is dd.hh.mm:ss, for example, 24.00:00 = 24 hours. - - Unlimited - - Unlimited - - - None - - - DevicePasswordHistory - - The DevicePasswordHistory parameter specifies the number of previously used passwords to store. When a user creates a password, the user can't reuse a stored password that was previously used. - - Int32 - - Int32 - - - None - - - DevicePolicyRefreshInterval - - The DevicePolicyRefreshInterval parameter specifies how often the policy is sent from the server to the mobile phone. - - Unlimited - - Unlimited - - - None - - - IrmEnabled - - The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - IsDefaultPolicy - - 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. - - Boolean - - Boolean - - - None - - - MaxAttachmentSize - - The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile phone. The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - MaxCalendarAgeFilter - - 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 - - CalendarAgeFilterType - - CalendarAgeFilterType - - - None - - - MaxDevicePasswordFailedAttempts - - The MaxDevicePasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile phone. You can enter any number from 4 through 16. The default value is 8. - - Unlimited - - Unlimited - - - None - - - MaxEmailAgeFilter - - 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 - - EmailAgeFilterType - - EmailAgeFilterType - - - None - - - MaxEmailBodyTruncationSize - - The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile phone. The value is specified in kilobytes (KB). - - Unlimited - - Unlimited - - - None - - - MaxEmailHTMLBodyTruncationSize - - The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are synchronized to the mobile phone. The value is specified in KB. - - Unlimited - - Unlimited - - - None - - - MaxInactivityTimeDeviceLock - - The MaxInactivityTimeDeviceLock parameter specifies the length of time that the mobile phone can be inactive before the password is required to reactivate it. You can enter any interval between 30 seconds and 1 hour. The default value is 15 minutes. The format of the parameter is hh.mm:ss, for example, 15:00 = 15 minutes. - - Unlimited - - Unlimited - - - None - - - MinDevicePasswordComplexCharacters - - The MinDevicePasswordComplexCharacters parameter specifies the minimum number of complex characters required in a mobile phone password. A complex character isn't a letter. - - Int32 - - Int32 - - - None - - - MinDevicePasswordLength - - The MinDevicePasswordLength parameter specifies the minimum number of characters in the device password. You can enter any number from 1 through 16. The maximum length a password can be is 16 characters. The default value is 4. - - Int32 - - Int32 - - - None - - - Name - - The Name parameter specifies the friendly name of the Mobile Device mailbox policy. - - String - - String - - - None - - - PasswordRecoveryEnabled - - 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. - - Boolean - - Boolean - - - None - - - RequireDeviceEncryption - - The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireEncryptedSMIMEMessages - - The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireEncryptionSMIMEAlgorithm - - The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. - - EncryptionSMIMEAlgorithmType - - EncryptionSMIMEAlgorithmType - - - None - - - RequireManualSyncWhenRoaming - - The RequireManualSyncWhenRoaming parameter specifies whether the mobile phone must synchronize manually while roaming. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireSignedSMIMEAlgorithm - - The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. - - SignedSMIMEAlgorithmType - - SignedSMIMEAlgorithmType - - - None - - - RequireSignedSMIMEMessages - - The RequireSignedSMIMEMessages parameter specifies whether the mobile phone must send signed S/MIME messages. - - Boolean - - Boolean - - - None - - - RequireStorageCardEncryption - - 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. - - Boolean - - Boolean - - - None - - - UnapprovedInROMApplicationList - - The UnapprovedInROMApplicationList parameter contains a list of applications that can't be run in ROM. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UNCAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WSSAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - - - - Identity - - The Identity parameter specifies the Mobile Device mailbox policy. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - AllowApplePushNotifications - - This parameter is available only in the cloud-based service. - The AllowApplePushNotifications parameter specifies whether push notifications are allowed to Apple mobile devices. - - Boolean - - Boolean - - - None - - - 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. - - BluetoothType - - BluetoothType - - - None - - - AllowBrowser - - The AllowBrowser parameter indicates whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect third-party browsers. - - Boolean - - Boolean - - - None - - - AllowCamera - - The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowConsumerEmail - - The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the mobile phone. The default value is $true. This parameter doesn't control access to emails using third-party mobile phone email programs. - - Boolean - - Boolean - - - None - - - AllowDesktopSync - - The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowExternalDeviceManagement - - The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the mobile phone. - - Boolean - - Boolean - - - None - - - AllowHTMLEmail - - 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. - - Boolean - - Boolean - - - None - - - AllowInternetSharing - - 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. - - Boolean - - Boolean - - - None - - - AllowIrDA - - The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowMobileOTAUpdate - - The AllowMobileOTAUpdate parameter specifies whether the Exchange ActiveSync mailbox policy can be sent to the mobile phone over a cellular data connection. - - Boolean - - Boolean - - - None - - - AllowNonProvisionableDevices - - 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. - - Boolean - - Boolean - - - None - - - AllowPOPIMAPEmail - - The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile phone. The default value is $true. This parameter doesn't control access by third-party email programs. - - Boolean - - Boolean - - - None - - - AllowRemoteDesktop - - The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowSimpleDevicePassword - - 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. - - Boolean - - Boolean - - - None - - - AllowSMIMEEncryptionAlgorithmNegotiation - - 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. - - SMIMEEncryptionAlgorithmNegotiationType - - SMIMEEncryptionAlgorithmNegotiationType - - - None - - - AllowSMIMESoftCerts - - The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowStorageCard - - The AllowStorageCard parameter specifies whether the mobile phone can access information stored on a storage card. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowTextMessaging - - The AllowTextMessaging parameter specifies whether text messaging is allowed from the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowUnsignedApplications - - The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowUnsignedInstallationPackages - - The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be executed on the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowWiFi - - The AllowWiFi parameter specifies whether wireless Internet access is allowed on the mobile phone. The default value is $true. - - Boolean - - Boolean - - - None - - - AlphanumericDevicePasswordRequired - - The AlphanumericDevicePasswordRequired parameter specifies whether the password for the mobile phone must be alphanumeric. The default value is $false. - - Boolean - - Boolean - - - None - - - ApprovedApplicationList - - The ApprovedApplicationList parameter specifies a list of approved applications for the mobile phone. - - ApprovedApplicationCollection - - ApprovedApplicationCollection - - - None - - - AttachmentsEnabled - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DeviceEncryptionEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePasswordEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePasswordExpiration - - The DevicePasswordExpiration parameter specifies the length of time, in days, that a password can be used. After this length of time, a new password must be created. The format of the parameter is dd.hh.mm:ss, for example, 24.00:00 = 24 hours. - - Unlimited - - Unlimited - - - None - - - DevicePasswordHistory - - The DevicePasswordHistory parameter specifies the number of previously used passwords to store. When a user creates a password, the user can't reuse a stored password that was previously used. - - Int32 - - Int32 - - - None - - - DevicePolicyRefreshInterval - - The DevicePolicyRefreshInterval parameter specifies how often the policy is sent from the server to the mobile phone. - - Unlimited - - Unlimited - - - None - - - IrmEnabled - - The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - IsDefaultPolicy - - 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. - - Boolean - - Boolean - - - None - - - MaxAttachmentSize - - The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile phone. The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - MaxCalendarAgeFilter - - 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 - - CalendarAgeFilterType - - CalendarAgeFilterType - - - None - - - MaxDevicePasswordFailedAttempts - - The MaxDevicePasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile phone. You can enter any number from 4 through 16. The default value is 8. - - Unlimited - - Unlimited - - - None - - - MaxEmailAgeFilter - - 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 - - EmailAgeFilterType - - EmailAgeFilterType - - - None - - - MaxEmailBodyTruncationSize - - The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile phone. The value is specified in kilobytes (KB). - - Unlimited - - Unlimited - - - None - - - MaxEmailHTMLBodyTruncationSize - - The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are synchronized to the mobile phone. The value is specified in KB. - - Unlimited - - Unlimited - - - None - - - MaxInactivityTimeDeviceLock - - The MaxInactivityTimeDeviceLock parameter specifies the length of time that the mobile phone can be inactive before the password is required to reactivate it. You can enter any interval between 30 seconds and 1 hour. The default value is 15 minutes. The format of the parameter is hh.mm:ss, for example, 15:00 = 15 minutes. - - Unlimited - - Unlimited - - - None - - - MinDevicePasswordComplexCharacters - - The MinDevicePasswordComplexCharacters parameter specifies the minimum number of complex characters required in a mobile phone password. A complex character isn't a letter. - - Int32 - - Int32 - - - None - - - MinDevicePasswordLength - - The MinDevicePasswordLength parameter specifies the minimum number of characters in the device password. You can enter any number from 1 through 16. The maximum length a password can be is 16 characters. The default value is 4. - - Int32 - - Int32 - - - None - - - Name - - The Name parameter specifies the friendly name of the Mobile Device mailbox policy. - - String - - String - - - None - - - PasswordRecoveryEnabled - - 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. - - Boolean - - Boolean - - - None - - - RequireDeviceEncryption - - The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireEncryptedSMIMEMessages - - The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireEncryptionSMIMEAlgorithm - - The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message. - - EncryptionSMIMEAlgorithmType - - EncryptionSMIMEAlgorithmType - - - None - - - RequireManualSyncWhenRoaming - - The RequireManualSyncWhenRoaming parameter specifies whether the mobile phone must synchronize manually while roaming. The default value is $false. - - Boolean - - Boolean - - - None - - - RequireSignedSMIMEAlgorithm - - The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message. - - SignedSMIMEAlgorithmType - - SignedSMIMEAlgorithmType - - - None - - - RequireSignedSMIMEMessages - - The RequireSignedSMIMEMessages parameter specifies whether the mobile phone must send signed S/MIME messages. - - Boolean - - Boolean - - - None - - - RequireStorageCardEncryption - - 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. - - Boolean - - Boolean - - - None - - - UnapprovedInROMApplicationList - - The UnapprovedInROMApplicationList parameter contains a list of applications that can't be run in ROM. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UNCAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WSSAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - Set-ActiveSyncMailboxPolicy -Identity:Default -DevicePasswordEnabled:$true -AlphanumericDevicePasswordRequired:$true -PasswordRecoveryEnabled:$true -MaxEmailAgeFilter:ThreeDays -AllowWiFi:$false -AllowStorageCard:$true -AllowPOPIMAPEmail:$false -IsDefault:$true -AllowTextMessaging:$true -Confirm:$true - - This example sets several policy settings for the Mobile Device mailbox policy Default and requires confirmation before applying the settings. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-activesyncmailboxpolicy - - - - - - Set-ActiveSyncOrganizationSettings - Set - ActiveSyncOrganizationSettings - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ActiveSyncOrganizationSettings - - 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. - - ActiveSyncOrganizationSettingsIdParameter - - ActiveSyncOrganizationSettingsIdParameter - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowAccessForUnSupportedPlatform - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - AllowRMSSupportForUnenlightenedApps - - This parameter is available or 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) - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - DeviceAccessLevel - - DeviceAccessLevel - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - ActiveSyncOrganizationSettingsIdParameter - - ActiveSyncOrganizationSettingsIdParameter - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowAccessForUnSupportedPlatform - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - AllowRMSSupportForUnenlightenedApps - - This parameter is available or 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) - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - DeviceAccessLevel - - DeviceAccessLevel - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-activesyncorganizationsettings - - - - - - Set-MobileDeviceMailboxPolicy - Set - MobileDeviceMailboxPolicy - - This cmdlet is available in 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-MobileDeviceMailboxPolicy cmdlet to modify mobile device mailbox policies. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Mobile device mailbox policies define settings for mobile devices that are used to access mailboxes in your organization. The default mobile device mailbox policy is applied to all new mailboxes that you create. You can assign a mobile device mailbox policy to existing mailboxes by using the Set-CASMailbox cmdlet, or by editing the mailbox properties in the Exchange admin center (EAC). - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MobileDeviceMailboxPolicy - - Identity - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - AllowApplePushNotifications - - 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. - - Boolean - - Boolean - - - None - - - 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. - - BluetoothType - - BluetoothType - - - None - - - AllowBrowser - - The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect third-party browsers. - - Boolean - - Boolean - - - None - - - AllowCamera - - 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. - - Boolean - - Boolean - - - None - - - AllowConsumerEmail - - The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using third-party mobile device email programs. - - Boolean - - Boolean - - - None - - - AllowDesktopSync - - 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. - - Boolean - - Boolean - - - None - - - AllowExternalDeviceManagement - - 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. - - Boolean - - Boolean - - - None - - - AllowGooglePushNotifications - - 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. - - Boolean - - Boolean - - - None - - - AllowHTMLEmail - - 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. - - Boolean - - Boolean - - - None - - - AllowInternetSharing - - 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. - - Boolean - - Boolean - - - None - - - AllowIrDA - - 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. - - Boolean - - Boolean - - - None - - - AllowMicrosoftPushNotifications - - 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. - - Boolean - - Boolean - - - None - - - AllowMobileOTAUpdate - - 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. - - Boolean - - Boolean - - - None - - - AllowNonProvisionableDevices - - The AllowNonProvisionableDevices parameter specifies whether all mobile devices can synchronize with Exchange. Valid input for this parameter is $true or $false. The default value is $true. - When set to $true, this parameter enables all mobile devices to synchronize with Exchange, regardless of whether the device can enforce all settings that are defined by the policy. This also includes mobile devices managed by a separate device management system. When set to $false, this parameter blocks mobile devices that aren't provisioned from synchronizing with Exchange. - - Boolean - - Boolean - - - None - - - AllowPOPIMAPEmail - - The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by third-party email programs. - - Boolean - - Boolean - - - None - - - AllowRemoteDesktop - - 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. - - Boolean - - Boolean - - - None - - - AllowSimplePassword - - 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. - - Boolean - - Boolean - - - None - - - AllowSMIMEEncryptionAlgorithmNegotiation - - 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. - - SMIMEEncryptionAlgorithmNegotiationType - - SMIMEEncryptionAlgorithmNegotiationType - - - None - - - AllowSMIMESoftCerts - - 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. - - Boolean - - Boolean - - - None - - - AllowStorageCard - - 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. - - Boolean - - Boolean - - - None - - - AllowTextMessaging - - 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. - - Boolean - - Boolean - - - None - - - AllowUnsignedApplications - - 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. - - Boolean - - Boolean - - - None - - - AllowUnsignedInstallationPackages - - 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. - - Boolean - - Boolean - - - None - - - AllowWiFi - - 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. - - Boolean - - Boolean - - - None - - - AlphanumericPasswordRequired - - 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. - - Boolean - - Boolean - - - None - - - ApprovedApplicationList - - The ApprovedApplicationList parameter specifies a configured list of approved applications for the device. - - ApprovedApplicationCollection - - ApprovedApplicationCollection - - - None - - - AttachmentsEnabled - - The AttachmentsEnabled parameter specifies whether attachments can be downloaded on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. - When set to $false, this parameter blocks the user from downloading attachments on the mobile device. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DeviceEncryptionEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePolicyRefreshInterval - - The DevicePolicyRefreshInterval parameter specifies how often the policy is sent to the mobile device. - To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - IrmEnabled - - 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. - - Boolean - - Boolean - - - None - - - IsDefault - - The IsDefault parameter specifies whether this policy is the default mobile device mailbox policy. Valid input for this parameter is $true or $false. The default value for the built-in mobile device mailbox policy named Default is $true. The default value for new mobile device mailbox policies that you create is $false. - There can be only one default policy. If another policy is currently set as the default, and you set this parameter to $true, this policy becomes the default policy. The value of this parameter on the other policy is automatically changed to $false, and that policy is no longer the default policy. - - Boolean - - Boolean - - - None - - - MaxAttachmentSize - - The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile device. Valid input for this parameter is a size value between 0 and 2147482624 bytes (approximately 2 GB), or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4096 or 4KB. - 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 - - Unlimited - - Unlimited - - - None - - - MaxCalendarAgeFilter - - 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. - - CalendarAgeFilterType - - CalendarAgeFilterType - - - None - - - MaxEmailAgeFilter - - 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. - - EmailAgeFilterType - - EmailAgeFilterType - - - None - - - MaxEmailBodyTruncationSize - - The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. - - Unlimited - - Unlimited - - - None - - - MaxEmailHTMLBodyTruncationSize - - The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. - - Unlimited - - Unlimited - - - None - - - MaxInactivityTimeLock - - 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. - - Unlimited - - Unlimited - - - None - - - MaxPasswordFailedAttempts - - The MaxPasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile device. - You can enter any number from 4 through 16 or the value Unlimited. The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - MinPasswordComplexCharacters - - 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. - For Windows Phone 8 devices, the value specifies the number of character sets that are required in the password. For example, the value 3 requires at least one character from any three of the character sets. - 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. - - Int32 - - Int32 - - - None - - - MinPasswordLength - - 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. - - Int32 - - Int32 - - - None - - - Name - - The Name parameter specifies the friendly name of the mobile device mailbox policy. - - String - - String - - - None - - - PasswordEnabled - - The PasswordEnabled parameter specifies whether a password is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. - When set to $true, this parameter requires the user to set a password on the mobile device. - - Boolean - - Boolean - - - None - - - PasswordExpiration - - 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 - - Unlimited - - Unlimited - - - None - - - PasswordHistory - - The PasswordHistory parameter specifies the number of unique new passwords that need to be created on the mobile device before an old password can be reused. - You can enter any number from 0 through 50. The default value is 0. - - Int32 - - Int32 - - - None - - - PasswordRecoveryEnabled - - The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile device is stored in Exchange. Valid input for this parameter is $true or $false. The default value is $false. - When set to $true, this parameter enables you to store the recovery password for the mobile device in Exchange. The recovery password can be viewed in Outlook on the web or the Exchange admin center. - - Boolean - - Boolean - - - None - - - RequireDeviceEncryption - - 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. - - Boolean - - Boolean - - - None - - - RequireEncryptedSMIMEMessages - - 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. - - Boolean - - Boolean - - - None - - - RequireEncryptionSMIMEAlgorithm - - 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. - - EncryptionSMIMEAlgorithmType - - EncryptionSMIMEAlgorithmType - - - None - - - RequireManualSyncWhenRoaming - - 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. - - Boolean - - Boolean - - - None - - - RequireSignedSMIMEAlgorithm - - The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to sign S/MIME messages on the mobile device. - Valid values for this parameter are SHA1 or MD5. The default value is SHA1. - - SignedSMIMEAlgorithmType - - SignedSMIMEAlgorithmType - - - None - - - RequireSignedSMIMEMessages - - 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. - - Boolean - - Boolean - - - None - - - RequireStorageCardEncryption - - The RequireStorageCardEncryption parameter specifies whether storage card encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. - Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. - - Boolean - - Boolean - - - None - - - UnapprovedInROMApplicationList - - The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM on the mobile device. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UNCAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WSSAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - - - - Identity - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - AllowApplePushNotifications - - 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. - - Boolean - - Boolean - - - None - - - 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. - - BluetoothType - - BluetoothType - - - None - - - AllowBrowser - - The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't affect third-party browsers. - - Boolean - - Boolean - - - None - - - AllowCamera - - 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. - - Boolean - - Boolean - - - None - - - AllowConsumerEmail - - The AllowConsumerEmail parameter specifies whether the user can configure a personal email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access to email accounts using third-party mobile device email programs. - - Boolean - - Boolean - - - None - - - AllowDesktopSync - - 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. - - Boolean - - Boolean - - - None - - - AllowExternalDeviceManagement - - 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. - - Boolean - - Boolean - - - None - - - AllowGooglePushNotifications - - 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. - - Boolean - - Boolean - - - None - - - AllowHTMLEmail - - 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. - - Boolean - - Boolean - - - None - - - AllowInternetSharing - - 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. - - Boolean - - Boolean - - - None - - - AllowIrDA - - 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. - - Boolean - - Boolean - - - None - - - AllowMicrosoftPushNotifications - - 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. - - Boolean - - Boolean - - - None - - - AllowMobileOTAUpdate - - 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. - - Boolean - - Boolean - - - None - - - AllowNonProvisionableDevices - - The AllowNonProvisionableDevices parameter specifies whether all mobile devices can synchronize with Exchange. Valid input for this parameter is $true or $false. The default value is $true. - When set to $true, this parameter enables all mobile devices to synchronize with Exchange, regardless of whether the device can enforce all settings that are defined by the policy. This also includes mobile devices managed by a separate device management system. When set to $false, this parameter blocks mobile devices that aren't provisioned from synchronizing with Exchange. - - Boolean - - Boolean - - - None - - - AllowPOPIMAPEmail - - The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. This parameter doesn't control access by third-party email programs. - - Boolean - - Boolean - - - None - - - AllowRemoteDesktop - - 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. - - Boolean - - Boolean - - - None - - - AllowSimplePassword - - 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. - - Boolean - - Boolean - - - None - - - AllowSMIMEEncryptionAlgorithmNegotiation - - 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. - - SMIMEEncryptionAlgorithmNegotiationType - - SMIMEEncryptionAlgorithmNegotiationType - - - None - - - AllowSMIMESoftCerts - - 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. - - Boolean - - Boolean - - - None - - - AllowStorageCard - - 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. - - Boolean - - Boolean - - - None - - - AllowTextMessaging - - 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. - - Boolean - - Boolean - - - None - - - AllowUnsignedApplications - - 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. - - Boolean - - Boolean - - - None - - - AllowUnsignedInstallationPackages - - 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. - - Boolean - - Boolean - - - None - - - AllowWiFi - - 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. - - Boolean - - Boolean - - - None - - - AlphanumericPasswordRequired - - 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. - - Boolean - - Boolean - - - None - - - ApprovedApplicationList - - The ApprovedApplicationList parameter specifies a configured list of approved applications for the device. - - ApprovedApplicationCollection - - ApprovedApplicationCollection - - - None - - - AttachmentsEnabled - - The AttachmentsEnabled parameter specifies whether attachments can be downloaded on the mobile device. Valid input for this parameter is $true or $false. The default value is $true. - When set to $false, this parameter blocks the user from downloading attachments on the mobile device. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DeviceEncryptionEnabled - - 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. - - Boolean - - Boolean - - - None - - - DevicePolicyRefreshInterval - - The DevicePolicyRefreshInterval parameter specifies how often the policy is sent to the mobile device. - To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - IrmEnabled - - 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. - - Boolean - - Boolean - - - None - - - IsDefault - - The IsDefault parameter specifies whether this policy is the default mobile device mailbox policy. Valid input for this parameter is $true or $false. The default value for the built-in mobile device mailbox policy named Default is $true. The default value for new mobile device mailbox policies that you create is $false. - There can be only one default policy. If another policy is currently set as the default, and you set this parameter to $true, this policy becomes the default policy. The value of this parameter on the other policy is automatically changed to $false, and that policy is no longer the default policy. - - Boolean - - Boolean - - - None - - - MaxAttachmentSize - - The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile device. Valid input for this parameter is a size value between 0 and 2147482624 bytes (approximately 2 GB), or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4096 or 4KB. - 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 - - Unlimited - - Unlimited - - - None - - - MaxCalendarAgeFilter - - 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. - - CalendarAgeFilterType - - CalendarAgeFilterType - - - None - - - MaxEmailAgeFilter - - 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. - - EmailAgeFilterType - - EmailAgeFilterType - - - None - - - MaxEmailBodyTruncationSize - - The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. - - Unlimited - - Unlimited - - - None - - - MaxEmailHTMLBodyTruncationSize - - The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are truncated when synchronized to the mobile device. Valid input for this parameter is an integer between 0 and 2147483647 (Int32) or the value Unlimited. The default value is Unlimited. - Unqualified values are treated as bytes. You can qualify the value with KB (kilobytes), MB (megabytes) or GB (gigabytes). For example, to set the limit to 4 kilobytes, enter the value 4KB or 4096. - - Unlimited - - Unlimited - - - None - - - MaxInactivityTimeLock - - 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. - - Unlimited - - Unlimited - - - None - - - MaxPasswordFailedAttempts - - The MaxPasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the mobile device. - You can enter any number from 4 through 16 or the value Unlimited. The default value is Unlimited. - - Unlimited - - Unlimited - - - None - - - MinPasswordComplexCharacters - - 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. - For Windows Phone 8 devices, the value specifies the number of character sets that are required in the password. For example, the value 3 requires at least one character from any three of the character sets. - 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. - - Int32 - - Int32 - - - None - - - MinPasswordLength - - 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. - - Int32 - - Int32 - - - None - - - Name - - The Name parameter specifies the friendly name of the mobile device mailbox policy. - - String - - String - - - None - - - PasswordEnabled - - The PasswordEnabled parameter specifies whether a password is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. - When set to $true, this parameter requires the user to set a password on the mobile device. - - Boolean - - Boolean - - - None - - - PasswordExpiration - - 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 - - Unlimited - - Unlimited - - - None - - - PasswordHistory - - The PasswordHistory parameter specifies the number of unique new passwords that need to be created on the mobile device before an old password can be reused. - You can enter any number from 0 through 50. The default value is 0. - - Int32 - - Int32 - - - None - - - PasswordRecoveryEnabled - - The PasswordRecoveryEnabled parameter specifies whether the recovery password for the mobile device is stored in Exchange. Valid input for this parameter is $true or $false. The default value is $false. - When set to $true, this parameter enables you to store the recovery password for the mobile device in Exchange. The recovery password can be viewed in Outlook on the web or the Exchange admin center. - - Boolean - - Boolean - - - None - - - RequireDeviceEncryption - - 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. - - Boolean - - Boolean - - - None - - - RequireEncryptedSMIMEMessages - - 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. - - Boolean - - Boolean - - - None - - - RequireEncryptionSMIMEAlgorithm - - 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. - - EncryptionSMIMEAlgorithmType - - EncryptionSMIMEAlgorithmType - - - None - - - RequireManualSyncWhenRoaming - - 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. - - Boolean - - Boolean - - - None - - - RequireSignedSMIMEAlgorithm - - The RequireSignedSMIMEAlgorithm parameter specifies the algorithm that's used to sign S/MIME messages on the mobile device. - Valid values for this parameter are SHA1 or MD5. The default value is SHA1. - - SignedSMIMEAlgorithmType - - SignedSMIMEAlgorithmType - - - None - - - RequireSignedSMIMEMessages - - 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. - - Boolean - - Boolean - - - None - - - RequireStorageCardEncryption - - The RequireStorageCardEncryption parameter specifies whether storage card encryption is required on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. - Setting this parameter to $true also sets the DeviceEncryptionEnabled parameter to $true. - - Boolean - - Boolean - - - None - - - UnapprovedInROMApplicationList - - The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM on the mobile device. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UNCAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WSSAccessEnabled - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - Set-MobileDeviceMailboxPolicy -Identity Default -PasswordEnabled $true -AlphanumericPasswordRequired $true -PasswordRecoveryEnabled $true -AllowWiFi $false -AllowStorageCard $true -AllowPOPIMAPEmail $false -IsDefault $true -AllowTextMessaging $true -Confirm $true - - This example sets several policy settings for the mobile device mailbox policy Default and requires confirmation before applying the settings. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mobiledevicemailboxpolicy - - - - - - Set-UMAutoAttendant - Set - UMAutoAttendant - - This cmdlet is available in 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-UMAutoAttendant cmdlet to modify an existing Unified Messaging (UM) auto attendant. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Set-UMAutoAttendant cmdlet changes or modifies the settings of an existing UM auto attendant. By default, some UM auto attendant parameters are required and are created. However, after a UM auto attendant is created, not all properties for the UM auto attendant are writable. Therefore, some values for the UM auto attendant can't be changed or modified unless the UM auto attendant is deleted and a new UM auto attendant is created. - After this task is completed, the parameters and values specified are configured on the UM auto attendant. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UMAutoAttendant - - Identity - - The Identity parameter specifies the identifier for the UM auto attendant being viewed. This parameter is the directory object ID for the UM auto attendant. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - AfterHoursKeyMapping - - The AfterHoursKeyMapping parameter specifies the key mappings to be used for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. - The following is an example for a custom table that has two entries: - "Sales, 77899","Service, 78990". - The default value is disabled. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AfterHoursKeyMappingEnabled - - The AfterHoursKeyMappingEnabled parameter specifies whether to enable or disable key mappings for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. - The following is an example for a custom table that has two entries: - "Sales, 77899","Service, 78990". - - Boolean - - Boolean - - - None - - - AfterHoursMainMenuCustomPromptEnabled - - The AfterHoursMainMenuCustomPromptEnabled parameter specifies whether the after business hours custom main menu is enabled. The default value is disabled. - - Boolean - - Boolean - - - None - - - AfterHoursMainMenuCustomPromptFilename - - The AfterHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the after business hours custom main menu prompt. - - String - - String - - - None - - - AfterHoursTransferToOperatorEnabled - - The AfterHoursTransferToOperatorEnabled parameter specifies whether to allow calls to be transferred to the operator's extension number after business hours. - - Boolean - - Boolean - - - None - - - AfterHoursWelcomeGreetingEnabled - - 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. - - Boolean - - Boolean - - - None - - - AfterHoursWelcomeGreetingFilename - - The AfterHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the after hours greeting message. - - String - - String - - - None - - - AllowDialPlanSubscribers - - 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. - - Boolean - - Boolean - - - None - - - AllowedInCountryOrRegionGroups - - The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/region dial group names allowed. The names must match group names defined in the dial plan. The string must have fewer than 128 characters. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedInternationalGroups - - The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The names must match group names defined in the dial plan. The string must have fewer than 128 characters. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowExtensions - - 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. - - Boolean - - Boolean - - - None - - - BusinessHoursKeyMapping - - The BusinessHoursKeyMapping parameter specifies the key mappings for business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. - The following is an example for a custom table that has two entries: - "Sales, 77899","Service, 78990". - The default is disabled. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - BusinessHoursKeyMappingEnabled - - The BusinessHoursKeyMappingEnabled parameter specifies whether the custom menus for business hours are enabled or disabled. The default value is disabled. - - Boolean - - Boolean - - - None - - - BusinessHoursMainMenuCustomPromptEnabled - - The BusinessHoursMainMenuCustomPromptEnabled parameter specifies whether the business hours custom main menu prompt is enabled. The default value is disabled. - - Boolean - - Boolean - - - None - - - BusinessHoursMainMenuCustomPromptFilename - - The BusinessHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the business hours custom main menu prompt. - - String - - String - - - None - - - 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.) - - ScheduleInterval[] - - ScheduleInterval[] - - - None - - - BusinessHoursTransferToOperatorEnabled - - The BusinessHoursTransferToOperatorEnabled parameter specifies whether to allow call transfers to the operator's extension number during business hours. - - Boolean - - Boolean - - - None - - - BusinessHoursWelcomeGreetingEnabled - - 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. - - Boolean - - Boolean - - - None - - - BusinessHoursWelcomeGreetingFilename - - The BusinessHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the welcome message. - - String - - String - - - None - - - BusinessLocation - - The BusinessLocation parameter specifies what the Mailbox server should read to the caller who selected the business location option on a UM auto attendant menu. - - String - - String - - - None - - - BusinessName - - The BusinessName parameter specifies the name of the company or organization being used to generate the UM auto attendant welcome greeting for callers. - - String - - String - - - None - - - CallSomeoneEnabled - - The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ContactAddressList - - The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - ContactRecipientContainer - - The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - ContactScope - - 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. - - DialScopeEnum - - DialScopeEnum - - - None - - - DTMFFallbackAutoAttendant - - The DTMFFallbackAutoAttendant parameter specifies the dual tone multi-frequency (DTMF) auto attendant used if the speech-enabled auto attendant is unavailable. If the SpeechEnabled parameter is set to $true, this auto attendant must have an associated DTMF auto attendant to use as the fallback auto attendant. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - ForceUpgrade - - The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM auto attendant object is upgraded. - - - SwitchParameter - - - False - - - HolidaySchedule - - 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". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - InfoAnnouncementEnabled - - The InfoAnnouncementEnabled parameter specifies whether to enable the informational greeting. The default setting is $true. - - InfoAnnouncementEnabledEnum - - InfoAnnouncementEnabledEnum - - - None - - - InfoAnnouncementFilename - - The InfoAnnouncementFilename parameter specifies the .wav file to be used for the informational announcement. - - String - - String - - - None - - - Language - - The Language parameter specifies the language used by the UM auto attendant. This language is selected from the list of available dial plan languages. - - UMLanguage - - UMLanguage - - - None - - - MatchedNameSelectionMethod - - 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 - - AutoAttendantDisambiguationFieldEnum - - AutoAttendantDisambiguationFieldEnum - - - None - - - Name - - The Name parameter specifies the display name to be used for the UM auto attendant. This name is limited to 64 characters. - - String - - String - - - None - - - NameLookupEnabled - - 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. - - Boolean - - Boolean - - - None - - - OperatorExtension - - The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the dial plan operator is used. If the dial plan operator isn't specified, the feature isn't enabled. - - String - - String - - - None - - - PilotIdentifierList - - The PilotIdentifierList parameter specifies a list of one or more pilot numbers. Pilot numbers are used to route incoming calls to Mailbox servers. The calls are then answered by the UM auto attendant. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SendVoiceMsgEnabled - - The SendVoiceMsgEnabled parameter specifies whether to allow the Send Message feature. - - Boolean - - Boolean - - - None - - - SpeechEnabled - - The SpeechEnabled parameter specifies whether the auto attendant is speech-enabled. The default setting on the UM auto attendant is $false. - - Boolean - - Boolean - - - None - - - Timezone - - The Timezone parameter specifies the time zone used with the auto attendant. The default time zone is the time zone setting on the server. - - String - - String - - - None - - - Timezone - - The Timezone parameter specifies the time zone used with the auto attendant. The default time zone is the time zone setting on the server. - - String - - String - - - None - - - TimeZoneName - - The TimeZoneName parameter specifies all or part of a MicrosoftWindows time zone display name. The string is compared to the display names in the local system registry to determine a simple contains match. An error is returned if the time zone name isn't correct. - - UMTimeZone - - UMTimeZone - - - None - - - WeekStartDay - - 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. - - DayOfWeek - - DayOfWeek - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identifier for the UM auto attendant being viewed. This parameter is the directory object ID for the UM auto attendant. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - AfterHoursKeyMapping - - The AfterHoursKeyMapping parameter specifies the key mappings to be used for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. - The following is an example for a custom table that has two entries: - "Sales, 77899","Service, 78990". - The default value is disabled. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AfterHoursKeyMappingEnabled - - The AfterHoursKeyMappingEnabled parameter specifies whether to enable or disable key mappings for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. - The following is an example for a custom table that has two entries: - "Sales, 77899","Service, 78990". - - Boolean - - Boolean - - - None - - - AfterHoursMainMenuCustomPromptEnabled - - The AfterHoursMainMenuCustomPromptEnabled parameter specifies whether the after business hours custom main menu is enabled. The default value is disabled. - - Boolean - - Boolean - - - None - - - AfterHoursMainMenuCustomPromptFilename - - The AfterHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the after business hours custom main menu prompt. - - String - - String - - - None - - - AfterHoursTransferToOperatorEnabled - - The AfterHoursTransferToOperatorEnabled parameter specifies whether to allow calls to be transferred to the operator's extension number after business hours. - - Boolean - - Boolean - - - None - - - AfterHoursWelcomeGreetingEnabled - - 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. - - Boolean - - Boolean - - - None - - - AfterHoursWelcomeGreetingFilename - - The AfterHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the after hours greeting message. - - String - - String - - - None - - - AllowDialPlanSubscribers - - 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. - - Boolean - - Boolean - - - None - - - AllowedInCountryOrRegionGroups - - The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/region dial group names allowed. The names must match group names defined in the dial plan. The string must have fewer than 128 characters. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedInternationalGroups - - The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The names must match group names defined in the dial plan. The string must have fewer than 128 characters. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowExtensions - - 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. - - Boolean - - Boolean - - - None - - - BusinessHoursKeyMapping - - The BusinessHoursKeyMapping parameter specifies the key mappings for business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator. - The following is an example for a custom table that has two entries: - "Sales, 77899","Service, 78990". - The default is disabled. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - BusinessHoursKeyMappingEnabled - - The BusinessHoursKeyMappingEnabled parameter specifies whether the custom menus for business hours are enabled or disabled. The default value is disabled. - - Boolean - - Boolean - - - None - - - BusinessHoursMainMenuCustomPromptEnabled - - The BusinessHoursMainMenuCustomPromptEnabled parameter specifies whether the business hours custom main menu prompt is enabled. The default value is disabled. - - Boolean - - Boolean - - - None - - - BusinessHoursMainMenuCustomPromptFilename - - The BusinessHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the business hours custom main menu prompt. - - String - - String - - - None - - - 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.) - - ScheduleInterval[] - - ScheduleInterval[] - - - None - - - BusinessHoursTransferToOperatorEnabled - - The BusinessHoursTransferToOperatorEnabled parameter specifies whether to allow call transfers to the operator's extension number during business hours. - - Boolean - - Boolean - - - None - - - BusinessHoursWelcomeGreetingEnabled - - 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. - - Boolean - - Boolean - - - None - - - BusinessHoursWelcomeGreetingFilename - - The BusinessHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the welcome message. - - String - - String - - - None - - - BusinessLocation - - The BusinessLocation parameter specifies what the Mailbox server should read to the caller who selected the business location option on a UM auto attendant menu. - - String - - String - - - None - - - BusinessName - - The BusinessName parameter specifies the name of the company or organization being used to generate the UM auto attendant welcome greeting for callers. - - String - - String - - - None - - - CallSomeoneEnabled - - The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ContactAddressList - - The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - ContactRecipientContainer - - The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - ContactScope - - 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. - - DialScopeEnum - - DialScopeEnum - - - None - - - DTMFFallbackAutoAttendant - - The DTMFFallbackAutoAttendant parameter specifies the dual tone multi-frequency (DTMF) auto attendant used if the speech-enabled auto attendant is unavailable. If the SpeechEnabled parameter is set to $true, this auto attendant must have an associated DTMF auto attendant to use as the fallback auto attendant. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - ForceUpgrade - - The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM auto attendant object is upgraded. - - SwitchParameter - - SwitchParameter - - - False - - - HolidaySchedule - - 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". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - InfoAnnouncementEnabled - - The InfoAnnouncementEnabled parameter specifies whether to enable the informational greeting. The default setting is $true. - - InfoAnnouncementEnabledEnum - - InfoAnnouncementEnabledEnum - - - None - - - InfoAnnouncementFilename - - The InfoAnnouncementFilename parameter specifies the .wav file to be used for the informational announcement. - - String - - String - - - None - - - Language - - The Language parameter specifies the language used by the UM auto attendant. This language is selected from the list of available dial plan languages. - - UMLanguage - - UMLanguage - - - None - - - MatchedNameSelectionMethod - - 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 - - AutoAttendantDisambiguationFieldEnum - - AutoAttendantDisambiguationFieldEnum - - - None - - - Name - - The Name parameter specifies the display name to be used for the UM auto attendant. This name is limited to 64 characters. - - String - - String - - - None - - - NameLookupEnabled - - 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. - - Boolean - - Boolean - - - None - - - OperatorExtension - - The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the dial plan operator is used. If the dial plan operator isn't specified, the feature isn't enabled. - - String - - String - - - None - - - PilotIdentifierList - - The PilotIdentifierList parameter specifies a list of one or more pilot numbers. Pilot numbers are used to route incoming calls to Mailbox servers. The calls are then answered by the UM auto attendant. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SendVoiceMsgEnabled - - The SendVoiceMsgEnabled parameter specifies whether to allow the Send Message feature. - - Boolean - - Boolean - - - None - - - SpeechEnabled - - The SpeechEnabled parameter specifies whether the auto attendant is speech-enabled. The default setting on the UM auto attendant is $false. - - Boolean - - Boolean - - - None - - - Timezone - - The Timezone parameter specifies the time zone used with the auto attendant. The default time zone is the time zone setting on the server. - - String - - String - - - None - - - Timezone - - The Timezone parameter specifies the time zone used with the auto attendant. The default time zone is the time zone setting on the server. - - String - - String - - - None - - - TimeZoneName - - The TimeZoneName parameter specifies all or part of a MicrosoftWindows time zone display name. The string is compared to the display names in the local system registry to determine a simple contains match. An error is returned if the time zone name isn't correct. - - UMTimeZone - - UMTimeZone - - - None - - - WeekStartDay - - 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. - - DayOfWeek - - DayOfWeek - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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" - - 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. - - - - -------------------------- Example 3 -------------------------- - Set-UMAutoAttendant -Identity MyAutoAttendant -BusinessHoursKeyMappingEnabled $true -BusinessHoursKeyMapping "1,Sales,,SalesAutoAttendant","2,Support,12345","3,Directions,,,directions.wav" - - This example configures the UM auto attendant MyAutoAttendant and enables business hours key mappings so that when callers press 1, they're forwarded to another UM auto attendant named SalesAutoAttendant. When they press 2, they're forwarded to extension number 12345 for Support, and when they press 3, they're sent to another auto attendant that plays an audio file. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-umautoattendant - - - - - - Set-UMCallAnsweringRule - Set - UMCallAnsweringRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UMCallAnsweringRule - - Identity - - The Identity parameter specifies the identifier for a call answering rule being changed. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - CallersCanInterruptGreeting - - The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. - - Boolean - - Boolean - - - None - - - CheckAutomaticReplies - - The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - TimeOfDay - - TimeOfDay - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identifier for a call answering rule being changed. - - UMCallAnsweringRuleIdParameter - - UMCallAnsweringRuleIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - CallersCanInterruptGreeting - - The CallersCanInterruptGreeting parameter specifies whether a caller can interrupt the voice mail greeting while it's being played. The default is $null. - - Boolean - - Boolean - - - None - - - CheckAutomaticReplies - - The CheckAutomaticReplies parameter specifies an entry for the "If My Automatic Replies are Enabled" condition. The default is $false. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - TimeOfDay - - TimeOfDay - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-umcallansweringrule - - - - - - Set-UMDialPlan - Set - UMDialPlan - - This cmdlet is available in 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-UMDialPlan cmdlet to set various properties on a Unified Messaging (UM) dial plan. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UMDialPlan - - Identity - - The Identity parameter specifies the UM dial plan ID. This parameter is the directory object identifier for the UM dial plan. This parameter is used to link mailboxes and Mailbox and Client Access servers to dial plans. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - AccessTelephoneNumbers - - The AccessTelephoneNumbers parameter specifies a single valid voice mail pilot number or a list of valid voice mail pilot numbers. This list is presented to you when a user is being enabled for Unified Messaging. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowDialPlanSubscribers - - 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. - - Boolean - - Boolean - - - None - - - AllowedInCountryOrRegionGroups - - The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/region names from the same dial group that can be dialed. The name of the allowed in-country/region group must match the group name specified in the UM dial plan. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedInternationalGroups - - The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The international dial group name must match the group name specified in the dial plan. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowExtensions - - The AllowExtensions parameter specifies whether to allow calls to dial plan extensions. The default value is $false. - - Boolean - - Boolean - - - None - - - AllowHeuristicADCallingLineIdResolution - - The AllowHeuristicADCallingLineIdResolution parameter specifies whether to allow calling line ID resolution using telephone number fields that may be configured in Active Directory. When this parameter is set to $true, the telephone numbers such as those defined in the Mobile or Home telephone number fields in Active Directory are used. Setting this parameter to $true allows for resolution of calling IDs for both UM-enabled and non-UM-enabled users. The default is $true. You may want to set this parameter to $false if the telephone numbers for users aren't in a standard format. If the telephone numbers aren't in a standard format, the Mailbox server may not be able to correctly resolve the caller ID to a name of a user in a consistent manner. - - Boolean - - Boolean - - - None - - - AudioCodec - - The AudioCodec parameter specifies the audio codec used for recording. Mp3 is the default setting. - - AudioCodecEnum - - AudioCodecEnum - - - None - - - AutomaticSpeechRecognitionEnabled - - The AutomaticSpeechRecognitionEnabled parameter specifies whether Automatic Speech Recognition (ASR) is enabled for users who are members of the dial plan. - - Boolean - - Boolean - - - None - - - CallAnsweringRulesEnabled - - The CallAnsweringRulesEnabled parameter specifies whether Call Answering Rules are enabled for UM-enabled users associated with the UM dial plan. - - Boolean - - Boolean - - - None - - - CallSomeoneEnabled - - The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. - - Boolean - - Boolean - - - None - - - ConfiguredInCountryOrRegionGroups - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ConfiguredInternationalGroups - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ContactAddressList - - The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - ContactRecipientContainer - - The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - ContactScope - - 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. - - CallSomeoneScopeEnum - - CallSomeoneScopeEnum - - - None - - - 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. - - String - - String - - - None - - - DefaultLanguage - - The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. The default value is U.S. English. - - UMLanguage - - UMLanguage - - - None - - - DialByNamePrimary - - The DialByNamePrimary parameter specifies that the Dial by Name lookup key is to be created from the specified source. The default value is LastFirst. - - DialByNamePrimaryEnum - - DialByNamePrimaryEnum - - - None - - - DialByNameSecondary - - 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. - - DialByNameSecondaryEnum - - DialByNameSecondaryEnum - - - None - - - EquivalentDialPlanPhoneContexts - - The EquivalentDialPlanPhoneContexts parameter specifies the name of an equivalency dial plan. This parameter can be used when two UM dial plans exist but are in different forests or when a Private Branch eXchange (PBX) numbering plan spans two UM dial plans. Adding the name of the equivalency dial plan allows name lookups using a caller ID to search in the user's dial plan but then also search for a name for the calling line ID in any equivalent dial plans that are configured. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Extension - - The Extension parameter specifies the extension number used by the Call Someone feature when a call is transferred. - - String - - String - - - None - - - FaxEnabled - - 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. - - Boolean - - Boolean - - - None - - - ForceUpgrade - - The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM dial plan object is upgraded. - - - SwitchParameter - - - False - - - InCountryOrRegionNumberFormat - - The InCountryOrRegionNumberFormat parameter specifies the prefix string to use and the number of digits to take from the directory. This number is used when dialing into this dial plan from inside the same country or region code. - - NumberFormat - - NumberFormat - - - None - - - InfoAnnouncementEnabled - - 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. - - InfoAnnouncementEnabledEnum - - InfoAnnouncementEnabledEnum - - - None - - - InfoAnnouncementFilename - - The InfoAnnouncementFilename parameter specifies the audio file name for an informational announcement. - - String - - String - - - None - - - InputFailuresBeforeDisconnect - - The InputFailuresBeforeDisconnect parameter specifies the number of sequential user input errors allowed before the call is disconnected. The default value is 3. - - Int32 - - Int32 - - - None - - - InternationalAccessCode - - The InternationalAccessCode parameter specifies the code that precedes a telephone number to dial international calls. For example, 011 is the code used to call the United States. - - String - - String - - - None - - - InternationalNumberFormat - - The InternationalNumberFormat parameter specifies the prefix string to use and the number of digits to take from the directory, when dialing into this dial plan from a different country code. - - NumberFormat - - NumberFormat - - - None - - - LegacyPromptPublishingPoint - - The LegacyPromptPublishingPoint parameter was used to specify the location of the prompt publishing point for Exchange Server 2007 Unified Messaging servers. This parameter was used in coexistence scenarios when Exchange 2007 Unified Messaging servers were also included in the UM dial plan. - - String - - String - - - None - - - LogonFailuresBeforeDisconnect - - The LogonFailuresBeforeDisconnect parameter specifies the number of sequential unsuccessful logon attempts that can be made before the call is disconnected. The default value is 3. - - Int32 - - Int32 - - - None - - - MatchedNameSelectionMethod - - 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 - - DisambiguationFieldEnum - - DisambiguationFieldEnum - - - None - - - MaxCallDuration - - The MaxCallDuration parameter specifies the maximum length of time that a call can last before it's interrupted and the call is dropped. The default value is 30 minutes. - - Int32 - - Int32 - - - None - - - MaxRecordingDuration - - The MaxRecordingDuration parameter specifies the maximum length of time that messages can be recorded. This includes all kinds of calls. The default is 20 minutes. The value of this setting can be from 1 through 100. Setting this value too low can cause long voice messages to be disconnected before they are completed. Setting this value too high lets users save lengthy voice messages in their Inboxes. - - Int32 - - Int32 - - - None - - - Name - - The Name parameter specifies the display name to use for the UM dial plan. This name is limited to 64 characters. - - String - - String - - - None - - - NationalNumberPrefix - - The NationalNumberPrefix parameter specifies the dialing code that precedes a telephone number when placing calls from one local area to another within a specific country or region. For example, 1 is the code used within North America, and 0 is the code used within the United Kingdom. - - String - - String - - - None - - - NumberingPlanFormats - - The NumberingPlanFormats parameter specifies one or more phone number masks that can be used for resolving caller ID to names of users in Active Directory. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OperatorExtension - - The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the Do Not Allow Transfer to the Operator feature is unavailable. - - String - - String - - - None - - - OutsideLineAccessCode - - The OutsideLineAccessCode parameter specifies the code that precedes a telephone number to dial an external in-country telephone number. This code is also referred to as a trunk access code. The default value is 9. - - String - - String - - - None - - - PilotIdentifierList - - The PilotIdentifierList parameter specifies the pilot numbers configured on the dial plan. A single dial plan can have multiple pilot numbers. The pilot numbers must be in the E.164 format. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecordingIdleTimeout - - The RecordingIdleTimeout parameter specifies the length of time that a caller can be silent when recording a voice message before the recording is ended. The default value is 5 seconds. - - Int32 - - Int32 - - - None - - - SendVoiceMsgEnabled - - The SendVoiceMsgEnabled parameter specifies whether the Send Message feature is enabled. - - Boolean - - Boolean - - - None - - - TUIPromptEditingEnabled - - 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. - - Boolean - - Boolean - - - None - - - UMAutoAttendant - - The UMAutoAttendant parameter specifies the auto attendant run when the caller presses the star (*) key. If this parameter is specified, it overrides the Call Someone feature. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - WelcomeGreetingEnabled - - The WelcomeGreetingEnabled parameter specifies whether a custom welcome greeting is enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - WelcomeGreetingFilename - - The WelcomeGreetingFilename parameter specifies the audio file name for the welcome greeting. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the UM dial plan ID. This parameter is the directory object identifier for the UM dial plan. This parameter is used to link mailboxes and Mailbox and Client Access servers to dial plans. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - AccessTelephoneNumbers - - The AccessTelephoneNumbers parameter specifies a single valid voice mail pilot number or a list of valid voice mail pilot numbers. This list is presented to you when a user is being enabled for Unified Messaging. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowDialPlanSubscribers - - 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. - - Boolean - - Boolean - - - None - - - AllowedInCountryOrRegionGroups - - The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/region names from the same dial group that can be dialed. The name of the allowed in-country/region group must match the group name specified in the UM dial plan. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedInternationalGroups - - The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The international dial group name must match the group name specified in the dial plan. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowExtensions - - The AllowExtensions parameter specifies whether to allow calls to dial plan extensions. The default value is $false. - - Boolean - - Boolean - - - None - - - AllowHeuristicADCallingLineIdResolution - - The AllowHeuristicADCallingLineIdResolution parameter specifies whether to allow calling line ID resolution using telephone number fields that may be configured in Active Directory. When this parameter is set to $true, the telephone numbers such as those defined in the Mobile or Home telephone number fields in Active Directory are used. Setting this parameter to $true allows for resolution of calling IDs for both UM-enabled and non-UM-enabled users. The default is $true. You may want to set this parameter to $false if the telephone numbers for users aren't in a standard format. If the telephone numbers aren't in a standard format, the Mailbox server may not be able to correctly resolve the caller ID to a name of a user in a consistent manner. - - Boolean - - Boolean - - - None - - - AudioCodec - - The AudioCodec parameter specifies the audio codec used for recording. Mp3 is the default setting. - - AudioCodecEnum - - AudioCodecEnum - - - None - - - AutomaticSpeechRecognitionEnabled - - The AutomaticSpeechRecognitionEnabled parameter specifies whether Automatic Speech Recognition (ASR) is enabled for users who are members of the dial plan. - - Boolean - - Boolean - - - None - - - CallAnsweringRulesEnabled - - The CallAnsweringRulesEnabled parameter specifies whether Call Answering Rules are enabled for UM-enabled users associated with the UM dial plan. - - Boolean - - Boolean - - - None - - - CallSomeoneEnabled - - The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. - - Boolean - - Boolean - - - None - - - ConfiguredInCountryOrRegionGroups - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ConfiguredInternationalGroups - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ContactAddressList - - The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - ContactRecipientContainer - - The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - ContactScope - - 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. - - CallSomeoneScopeEnum - - CallSomeoneScopeEnum - - - None - - - 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. - - String - - String - - - None - - - DefaultLanguage - - The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. The default value is U.S. English. - - UMLanguage - - UMLanguage - - - None - - - DialByNamePrimary - - The DialByNamePrimary parameter specifies that the Dial by Name lookup key is to be created from the specified source. The default value is LastFirst. - - DialByNamePrimaryEnum - - DialByNamePrimaryEnum - - - None - - - DialByNameSecondary - - 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. - - DialByNameSecondaryEnum - - DialByNameSecondaryEnum - - - None - - - EquivalentDialPlanPhoneContexts - - The EquivalentDialPlanPhoneContexts parameter specifies the name of an equivalency dial plan. This parameter can be used when two UM dial plans exist but are in different forests or when a Private Branch eXchange (PBX) numbering plan spans two UM dial plans. Adding the name of the equivalency dial plan allows name lookups using a caller ID to search in the user's dial plan but then also search for a name for the calling line ID in any equivalent dial plans that are configured. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Extension - - The Extension parameter specifies the extension number used by the Call Someone feature when a call is transferred. - - String - - String - - - None - - - FaxEnabled - - 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. - - Boolean - - Boolean - - - None - - - ForceUpgrade - - The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM dial plan object is upgraded. - - SwitchParameter - - SwitchParameter - - - False - - - InCountryOrRegionNumberFormat - - The InCountryOrRegionNumberFormat parameter specifies the prefix string to use and the number of digits to take from the directory. This number is used when dialing into this dial plan from inside the same country or region code. - - NumberFormat - - NumberFormat - - - None - - - InfoAnnouncementEnabled - - 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. - - InfoAnnouncementEnabledEnum - - InfoAnnouncementEnabledEnum - - - None - - - InfoAnnouncementFilename - - The InfoAnnouncementFilename parameter specifies the audio file name for an informational announcement. - - String - - String - - - None - - - InputFailuresBeforeDisconnect - - The InputFailuresBeforeDisconnect parameter specifies the number of sequential user input errors allowed before the call is disconnected. The default value is 3. - - Int32 - - Int32 - - - None - - - InternationalAccessCode - - The InternationalAccessCode parameter specifies the code that precedes a telephone number to dial international calls. For example, 011 is the code used to call the United States. - - String - - String - - - None - - - InternationalNumberFormat - - The InternationalNumberFormat parameter specifies the prefix string to use and the number of digits to take from the directory, when dialing into this dial plan from a different country code. - - NumberFormat - - NumberFormat - - - None - - - LegacyPromptPublishingPoint - - The LegacyPromptPublishingPoint parameter was used to specify the location of the prompt publishing point for Exchange Server 2007 Unified Messaging servers. This parameter was used in coexistence scenarios when Exchange 2007 Unified Messaging servers were also included in the UM dial plan. - - String - - String - - - None - - - LogonFailuresBeforeDisconnect - - The LogonFailuresBeforeDisconnect parameter specifies the number of sequential unsuccessful logon attempts that can be made before the call is disconnected. The default value is 3. - - Int32 - - Int32 - - - None - - - MatchedNameSelectionMethod - - 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 - - DisambiguationFieldEnum - - DisambiguationFieldEnum - - - None - - - MaxCallDuration - - The MaxCallDuration parameter specifies the maximum length of time that a call can last before it's interrupted and the call is dropped. The default value is 30 minutes. - - Int32 - - Int32 - - - None - - - MaxRecordingDuration - - The MaxRecordingDuration parameter specifies the maximum length of time that messages can be recorded. This includes all kinds of calls. The default is 20 minutes. The value of this setting can be from 1 through 100. Setting this value too low can cause long voice messages to be disconnected before they are completed. Setting this value too high lets users save lengthy voice messages in their Inboxes. - - Int32 - - Int32 - - - None - - - Name - - The Name parameter specifies the display name to use for the UM dial plan. This name is limited to 64 characters. - - String - - String - - - None - - - NationalNumberPrefix - - The NationalNumberPrefix parameter specifies the dialing code that precedes a telephone number when placing calls from one local area to another within a specific country or region. For example, 1 is the code used within North America, and 0 is the code used within the United Kingdom. - - String - - String - - - None - - - NumberingPlanFormats - - The NumberingPlanFormats parameter specifies one or more phone number masks that can be used for resolving caller ID to names of users in Active Directory. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OperatorExtension - - The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the Do Not Allow Transfer to the Operator feature is unavailable. - - String - - String - - - None - - - OutsideLineAccessCode - - The OutsideLineAccessCode parameter specifies the code that precedes a telephone number to dial an external in-country telephone number. This code is also referred to as a trunk access code. The default value is 9. - - String - - String - - - None - - - PilotIdentifierList - - The PilotIdentifierList parameter specifies the pilot numbers configured on the dial plan. A single dial plan can have multiple pilot numbers. The pilot numbers must be in the E.164 format. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecordingIdleTimeout - - The RecordingIdleTimeout parameter specifies the length of time that a caller can be silent when recording a voice message before the recording is ended. The default value is 5 seconds. - - Int32 - - Int32 - - - None - - - SendVoiceMsgEnabled - - The SendVoiceMsgEnabled parameter specifies whether the Send Message feature is enabled. - - Boolean - - Boolean - - - None - - - TUIPromptEditingEnabled - - 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. - - Boolean - - Boolean - - - None - - - UMAutoAttendant - - The UMAutoAttendant parameter specifies the auto attendant run when the caller presses the star (*) key. If this parameter is specified, it overrides the Call Someone feature. - - UMAutoAttendantIdParameter - - UMAutoAttendantIdParameter - - - None - - - WelcomeGreetingEnabled - - The WelcomeGreetingEnabled parameter specifies whether a custom welcome greeting is enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - WelcomeGreetingFilename - - The WelcomeGreetingFilename parameter specifies the audio file name for the welcome greeting. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 - - 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" - - This example configures the UM dial plan MyDialPlan with dialing rules. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-umdialplan - - - - - - Set-UMIPGateway - Set - UMIPGateway - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UMIPGateway - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - 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. - - UMSmartHost - - UMSmartHost - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - IPAddressFamily - - IPAddressFamily - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the display name for the UM IP gateway. This display name is limited to 64 characters. - - String - - String - - - None - - - OutcallsAllowed - - The OutcallsAllowed parameter specifies whether to allow this UM IP gateway to be used for outgoing calls. This doesn't govern call transfers. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Status - - The Status parameter specifies whether to enable or disable the UM IP gateway. Valid values are: - - Enabled - - Disabled - - NoNewCalls - - GatewayStatus - - GatewayStatus - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - UMIPGatewayIdParameter - - UMIPGatewayIdParameter - - - None - - - 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. - - UMSmartHost - - UMSmartHost - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - IPAddressFamily - - IPAddressFamily - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the display name for the UM IP gateway. This display name is limited to 64 characters. - - String - - String - - - None - - - OutcallsAllowed - - The OutcallsAllowed parameter specifies whether to allow this UM IP gateway to be used for outgoing calls. This doesn't govern call transfers. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Status - - The Status parameter specifies whether to enable or disable the UM IP gateway. Valid values are: - - Enabled - - Disabled - - NoNewCalls - - GatewayStatus - - GatewayStatus - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-umipgateway - - - - - - Set-UMMailbox - Set - UMMailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UMMailbox - - Identity - - The Identity parameter specifies the mailbox tht 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - AllowUMCallsFromNonUsers - - The AllowUMCallsFromNonUsers parameter specifies whether to exclude the mailbox from directory searches. - - AllowUMCallsFromNonUsersFlags - - AllowUMCallsFromNonUsersFlags - - - None - - - AnonymousCallersCanLeaveMessages - - The AnonymousCallersCanLeaveMessages parameter specifies whether diverted calls without a caller ID are allowed to leave a message. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - AudioCodecEnum - - AudioCodecEnum - - - None - - - CallAnsweringRulesEnabled - - The CallAnsweringRulesEnabled parameter specifies whether users can configure or set up Call Answering Rules for their accounts. The default value is $true. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - FaxEnabled - - The FaxEnabled parameter specifies whether a user is allowed to receive incoming faxes. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the display name for the user. The display name is limited to 64 characters. - - String - - String - - - None - - - OperatorNumber - - The OperatorNumber parameter specifies the string of digits for the personal operator. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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 set up instructions based on the mobile phone provider. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - TUIAccessToEmailEnabled - - The TUIAccessToEmailEnabled parameter specifies whether users can access their individual email messages over the telephone. The default value is $true. - - Boolean - - Boolean - - - None - - - UMMailboxPolicy - - The UMMailboxPolicy parameter specifies the UM mailbox policy associated with the UM-enabled user's mailbox. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - UMSMSNotificationOptions - - UMSMSNotificationOptions - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the mailbox tht 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - AllowUMCallsFromNonUsers - - The AllowUMCallsFromNonUsers parameter specifies whether to exclude the mailbox from directory searches. - - AllowUMCallsFromNonUsersFlags - - AllowUMCallsFromNonUsersFlags - - - None - - - AnonymousCallersCanLeaveMessages - - The AnonymousCallersCanLeaveMessages parameter specifies whether diverted calls without a caller ID are allowed to leave a message. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - AudioCodecEnum - - AudioCodecEnum - - - None - - - CallAnsweringRulesEnabled - - The CallAnsweringRulesEnabled parameter specifies whether users can configure or set up Call Answering Rules for their accounts. The default value is $true. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - FaxEnabled - - The FaxEnabled parameter specifies whether a user is allowed to receive incoming faxes. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the display name for the user. The display name is limited to 64 characters. - - String - - String - - - None - - - OperatorNumber - - The OperatorNumber parameter specifies the string of digits for the personal operator. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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 set up instructions based on the mobile phone provider. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - TUIAccessToEmailEnabled - - The TUIAccessToEmailEnabled parameter specifies whether users can access their individual email messages over the telephone. The default value is $true. - - Boolean - - Boolean - - - None - - - UMMailboxPolicy - - The UMMailboxPolicy parameter specifies the UM mailbox policy associated with the UM-enabled user's mailbox. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - UMSMSNotificationOptions - - UMSMSNotificationOptions - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-ummailbox - - - - - - Set-UMMailboxPIN - Set - UMMailboxPIN - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UMMailboxPIN - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SendEmail - - The SendEmail parameter specifies whether to send a PIN to the user in an email message. The default is $true. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SendEmail - - The SendEmail parameter specifies whether to send a PIN to the user in an email message. The default is $true. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-ummailboxpin - - - - - - Set-UMMailboxPolicy - Set - UMMailboxPolicy - - This cmdlet is available in 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-UMMailboxPolicy cmdlet to modify a Unified Messaging (UM) mailbox policy. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When the Set-UMMailboxPolicy cmdlet is used to modify UM mailbox policy objects, you can change settings such as PIN policies, message text settings, and dialing restrictions for a single UM-enabled recipient or multiple UM-enabled recipients. UM mailbox policies are associated with UM-enabled mailboxes and can be configured to increase the level of security for UM-enabled users. - After this task is completed, the parameters and values specified are configured on the UM mailbox policy. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UMMailboxPolicy - - Identity - - The Identity parameter specifies the identifier for the UM mailbox policy being modified. This is the directory object ID for the UM mailbox policy. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - AllowAutomaticSpeechRecognition - - The AllowAutomaticSpeechRecognition parameter specifies whether users associated with the UM mailbox policy can use Automatic Speech Recognition (ASR). The default value is $true. - - Boolean - - Boolean - - - None - - - AllowCallAnsweringRules - - 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. - - Boolean - - Boolean - - - None - - - AllowCommonPatterns - - 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. - - Boolean - - Boolean - - - None - - - AllowDialPlanSubscribers - - 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. - - Boolean - - Boolean - - - None - - - AllowedInCountryOrRegionGroups - - The AllowedInCountryOrRegionGroups parameter specifies whether to let subscribers dial the list of in-country/region dial group names. The names that subscribers are allowed to dial must match the group names defined in the UM dial plan. The string is limited to 128 characters. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedInternationalGroups - - The AllowedInternationalGroups parameter specifies whether to let subscribers dial the list of international dial group names. The names that subscribers dial must match the group names defined in the dial plan. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowExtensions - - 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. - - Boolean - - Boolean - - - None - - - AllowFax - - The AllowFax parameter specifies whether users associated with the UM mailbox policy are allowed to receive incoming faxes. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowMessageWaitingIndicator - - 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. - - Boolean - - Boolean - - - None - - - AllowMissedCallNotifications - - The AllowMissedCallNotifications parameter specifies whether missed call notifications are enabled for users associated with the UM mailbox policy. The default value is $true. - When you're integrating Unified Messaging and Lync Server or Skype for Business Server, missed call notifications aren't available to users who have mailboxes located on Exchange 2010 Mailbox servers. A missed call notification is generated when a user disconnects before the call is sent to a Mailbox server. - - Boolean - - Boolean - - - None - - - AllowPinlessVoiceMailAccess - - 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. - - Boolean - - Boolean - - - None - - - AllowPlayOnPhone - - 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. - - Boolean - - Boolean - - - None - - - AllowSMSNotification - - 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. - - Boolean - - Boolean - - - None - - - AllowSubscriberAccess - - 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. - - Boolean - - Boolean - - - None - - - AllowTUIAccessToCalendar - - 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. - - Boolean - - Boolean - - - None - - - AllowTUIAccessToDirectory - - The AllowTUIAccessToDirectory parameter specifies whether users associated with the UM mailbox policy can access the directory over the telephone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowTUIAccessToEmail - - 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. - - Boolean - - Boolean - - - None - - - AllowTUIAccessToPersonalContacts - - 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. - - Boolean - - Boolean - - - None - - - AllowVoiceMailAnalysis - - The AllowVoiceMailAnalysis parameter specifies whether a copy of each voice mail left for the users associated with the UM mailbox policy will be forwarded to Microsoft for analysis and improvement of our speech recognition features. - - Boolean - - Boolean - - - None - - - AllowVoiceMailPreview - - 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. - - Boolean - - Boolean - - - None - - - AllowVoiceResponseToOtherMessageTypes - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - FaxMessageText - - The FaxMessageText parameter specifies the text included in the body part of fax messages. This text is limited to 512 characters. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - InformCallerOfVoiceMailAnalysis - - The InformCallerOfVoiceMailAnalysis parameter specifies whether the callers leaving the voice mails will be informed about the possibility of their voice mails being forwarded to Microsoft for analysis. - - Boolean - - Boolean - - - None - - - LogonFailuresBeforePINReset - - The LogonFailuresBeforePINReset parameter specifies the number of sequential unsuccessful logon attempts before the mailbox PIN is automatically reset. To disable this feature, set this parameter to Unlimited. If this parameter isn't set to Unlimited, it must be set to less than the value of the MaxLogonAttempts parameter. The range is from 0 through 999. The default setting is 5. - - Unlimited - - Unlimited - - - None - - - MaxGreetingDuration - - The MaxGreetingDuration parameter specifies the maximum greeting length. The range is from 1 through 10 minutes. The default value is 5 minutes. - - Int32 - - Int32 - - - None - - - MaxLogonAttempts - - The MaxLogonAttempts parameter specifies the number of times users can try unsuccessfully to log on, in sequence, before the UM mailboxes are locked. The range is from 1 through 999. The default value is 15. - - Unlimited - - Unlimited - - - None - - - MinPINLength - - The MinPINLength parameter specifies the minimum number of digits required in a PIN for UM-enabled users. The range is from 4 through 24. The default value is 6. - - Int32 - - Int32 - - - None - - - Name - - The Name parameter specifies the display name for the UM mailbox policy. This setting is limited to 64 characters. - - String - - String - - - None - - - PINHistoryCount - - The PINHistoryCount parameter specifies the number of previous PINs that are remembered and aren't allowed during a PIN reset. This number includes the first time that the PIN was set. The range is from 1 through 20. The default value is 5. - - Int32 - - Int32 - - - None - - - PINLifetime - - The PINLifetime parameter specifies the number of days until a new password is required. The range is from 1 through 999. The default value is 60. If you specify Unlimited, the users' PINs won't expire. - - Unlimited - - Unlimited - - - None - - - ProtectAuthenticatedVoiceMail - - 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. - - DRMProtectionOptions - - DRMProtectionOptions - - - None - - - ProtectedVoiceMailText - - The ProtectedVoiceMailText parameter specifies the text included in the body part of the protected voice mail messages for UM-enabled users associated with the UM mailbox policy. This text can contain up to 512 characters. - - String - - String - - - None - - - ProtectUnauthenticatedVoiceMail - - 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. - - DRMProtectionOptions - - DRMProtectionOptions - - - None - - - RequireProtectedPlayOnPhone - - 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. - - Boolean - - Boolean - - - None - - - ResetPINText - - The ResetPINText parameter specifies the text to be included in the PIN reset email message. This text is limited to 512 characters. - - String - - String - - - None - - - SourceForestPolicyNames - - The SourceForestPolicyNames parameter specifies the name or names of the corresponding UM mailbox policy objects located in the source forest during a cross-forest migration. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan associated with the UM mailbox policy. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - UMEnabledText - - The UMEnabledText parameter specifies the text to be included when a user is enabled for Unified Messaging. This text is limited to 512 characters. - - String - - String - - - None - - - VoiceMailPreviewPartnerAddress - - The VoiceMailPreviewPartnerAddress parameter specifies the SMTP address of a Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is $null. - - SmtpAddress - - SmtpAddress - - - None - - - VoiceMailPreviewPartnerAssignedID - - The VoiceMailPreviewPartnerAssignedID parameter specifies the identification string, if any, provided to the organization by the Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is $null. - - String - - String - - - None - - - VoiceMailPreviewPartnerMaxDeliveryDelay - - The VoiceMailPreviewPartnerMaxDeliveryDelay parameter specifies the number of seconds that a Mailbox server waits for a Voice Mail Preview partner system to return a message with a Voice Mail Preview. If this time is exceeded, the Mailbox server delivers the voice mail message without a preview. The default value is 1200. The minimum value for this parameter is 300. - - Int32 - - Int32 - - - None - - - VoiceMailPreviewPartnerMaxMessageDuration - - The VoiceMailPreviewPartnerMaxMessageDuration parameter specifies the maximum duration, in seconds, of voice mail messages sent to the Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is 180. The minimum number for this parameter is 60. This setting should be set equal to the maximum value allowed by the Voice Mail Preview partner. - - Int32 - - Int32 - - - None - - - VoiceMailText - - The VoiceMailText parameter specifies the text to be included in the body part of voice mail messages. The parameter applies to call answering messages in addition to messages originated by an authenticated subscriber. This text is limited to 512 characters. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identifier for the UM mailbox policy being modified. This is the directory object ID for the UM mailbox policy. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - AllowAutomaticSpeechRecognition - - The AllowAutomaticSpeechRecognition parameter specifies whether users associated with the UM mailbox policy can use Automatic Speech Recognition (ASR). The default value is $true. - - Boolean - - Boolean - - - None - - - AllowCallAnsweringRules - - 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. - - Boolean - - Boolean - - - None - - - AllowCommonPatterns - - 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. - - Boolean - - Boolean - - - None - - - AllowDialPlanSubscribers - - 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. - - Boolean - - Boolean - - - None - - - AllowedInCountryOrRegionGroups - - The AllowedInCountryOrRegionGroups parameter specifies whether to let subscribers dial the list of in-country/region dial group names. The names that subscribers are allowed to dial must match the group names defined in the UM dial plan. The string is limited to 128 characters. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedInternationalGroups - - The AllowedInternationalGroups parameter specifies whether to let subscribers dial the list of international dial group names. The names that subscribers dial must match the group names defined in the dial plan. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowExtensions - - 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. - - Boolean - - Boolean - - - None - - - AllowFax - - The AllowFax parameter specifies whether users associated with the UM mailbox policy are allowed to receive incoming faxes. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowMessageWaitingIndicator - - 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. - - Boolean - - Boolean - - - None - - - AllowMissedCallNotifications - - The AllowMissedCallNotifications parameter specifies whether missed call notifications are enabled for users associated with the UM mailbox policy. The default value is $true. - When you're integrating Unified Messaging and Lync Server or Skype for Business Server, missed call notifications aren't available to users who have mailboxes located on Exchange 2010 Mailbox servers. A missed call notification is generated when a user disconnects before the call is sent to a Mailbox server. - - Boolean - - Boolean - - - None - - - AllowPinlessVoiceMailAccess - - 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. - - Boolean - - Boolean - - - None - - - AllowPlayOnPhone - - 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. - - Boolean - - Boolean - - - None - - - AllowSMSNotification - - 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. - - Boolean - - Boolean - - - None - - - AllowSubscriberAccess - - 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. - - Boolean - - Boolean - - - None - - - AllowTUIAccessToCalendar - - 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. - - Boolean - - Boolean - - - None - - - AllowTUIAccessToDirectory - - The AllowTUIAccessToDirectory parameter specifies whether users associated with the UM mailbox policy can access the directory over the telephone. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowTUIAccessToEmail - - 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. - - Boolean - - Boolean - - - None - - - AllowTUIAccessToPersonalContacts - - 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. - - Boolean - - Boolean - - - None - - - AllowVoiceMailAnalysis - - The AllowVoiceMailAnalysis parameter specifies whether a copy of each voice mail left for the users associated with the UM mailbox policy will be forwarded to Microsoft for analysis and improvement of our speech recognition features. - - Boolean - - Boolean - - - None - - - AllowVoiceMailPreview - - 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. - - Boolean - - Boolean - - - None - - - AllowVoiceResponseToOtherMessageTypes - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - FaxMessageText - - The FaxMessageText parameter specifies the text included in the body part of fax messages. This text is limited to 512 characters. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - InformCallerOfVoiceMailAnalysis - - The InformCallerOfVoiceMailAnalysis parameter specifies whether the callers leaving the voice mails will be informed about the possibility of their voice mails being forwarded to Microsoft for analysis. - - Boolean - - Boolean - - - None - - - LogonFailuresBeforePINReset - - The LogonFailuresBeforePINReset parameter specifies the number of sequential unsuccessful logon attempts before the mailbox PIN is automatically reset. To disable this feature, set this parameter to Unlimited. If this parameter isn't set to Unlimited, it must be set to less than the value of the MaxLogonAttempts parameter. The range is from 0 through 999. The default setting is 5. - - Unlimited - - Unlimited - - - None - - - MaxGreetingDuration - - The MaxGreetingDuration parameter specifies the maximum greeting length. The range is from 1 through 10 minutes. The default value is 5 minutes. - - Int32 - - Int32 - - - None - - - MaxLogonAttempts - - The MaxLogonAttempts parameter specifies the number of times users can try unsuccessfully to log on, in sequence, before the UM mailboxes are locked. The range is from 1 through 999. The default value is 15. - - Unlimited - - Unlimited - - - None - - - MinPINLength - - The MinPINLength parameter specifies the minimum number of digits required in a PIN for UM-enabled users. The range is from 4 through 24. The default value is 6. - - Int32 - - Int32 - - - None - - - Name - - The Name parameter specifies the display name for the UM mailbox policy. This setting is limited to 64 characters. - - String - - String - - - None - - - PINHistoryCount - - The PINHistoryCount parameter specifies the number of previous PINs that are remembered and aren't allowed during a PIN reset. This number includes the first time that the PIN was set. The range is from 1 through 20. The default value is 5. - - Int32 - - Int32 - - - None - - - PINLifetime - - The PINLifetime parameter specifies the number of days until a new password is required. The range is from 1 through 999. The default value is 60. If you specify Unlimited, the users' PINs won't expire. - - Unlimited - - Unlimited - - - None - - - ProtectAuthenticatedVoiceMail - - 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. - - DRMProtectionOptions - - DRMProtectionOptions - - - None - - - ProtectedVoiceMailText - - The ProtectedVoiceMailText parameter specifies the text included in the body part of the protected voice mail messages for UM-enabled users associated with the UM mailbox policy. This text can contain up to 512 characters. - - String - - String - - - None - - - ProtectUnauthenticatedVoiceMail - - 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. - - DRMProtectionOptions - - DRMProtectionOptions - - - None - - - RequireProtectedPlayOnPhone - - 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. - - Boolean - - Boolean - - - None - - - ResetPINText - - The ResetPINText parameter specifies the text to be included in the PIN reset email message. This text is limited to 512 characters. - - String - - String - - - None - - - SourceForestPolicyNames - - The SourceForestPolicyNames parameter specifies the name or names of the corresponding UM mailbox policy objects located in the source forest during a cross-forest migration. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UMDialPlan - - The UMDialPlan parameter specifies the UM dial plan associated with the UM mailbox policy. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - UMEnabledText - - The UMEnabledText parameter specifies the text to be included when a user is enabled for Unified Messaging. This text is limited to 512 characters. - - String - - String - - - None - - - VoiceMailPreviewPartnerAddress - - The VoiceMailPreviewPartnerAddress parameter specifies the SMTP address of a Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is $null. - - SmtpAddress - - SmtpAddress - - - None - - - VoiceMailPreviewPartnerAssignedID - - The VoiceMailPreviewPartnerAssignedID parameter specifies the identification string, if any, provided to the organization by the Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is $null. - - String - - String - - - None - - - VoiceMailPreviewPartnerMaxDeliveryDelay - - The VoiceMailPreviewPartnerMaxDeliveryDelay parameter specifies the number of seconds that a Mailbox server waits for a Voice Mail Preview partner system to return a message with a Voice Mail Preview. If this time is exceeded, the Mailbox server delivers the voice mail message without a preview. The default value is 1200. The minimum value for this parameter is 300. - - Int32 - - Int32 - - - None - - - VoiceMailPreviewPartnerMaxMessageDuration - - The VoiceMailPreviewPartnerMaxMessageDuration parameter specifies the maximum duration, in seconds, of voice mail messages sent to the Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default value is 180. The minimum number for this parameter is 60. This setting should be set equal to the maximum value allowed by the Voice Mail Preview partner. - - Int32 - - Int32 - - - None - - - VoiceMailText - - The VoiceMailText parameter specifies the text to be included in the body part of voice mail messages. The parameter applies to call answering messages in addition to messages originated by an authenticated subscriber. This text is limited to 512 characters. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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." - - This example configures the text of voice mail messages sent to UM-enabled users and the text included in an email message sent to a user who is UM-enabled. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-ummailboxpolicy - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.ProvisioningAndMigration-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.ProvisioningAndMigration-Help.xml deleted file mode 100644 index be467e915bbe..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.ProvisioningAndMigration-Help.xml +++ /dev/null @@ -1,24606 +0,0 @@ - - - - - Add-RecipientPermission - Add - RecipientPermission - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Add-RecipientPermission - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - AccessRights - - The AccessRights parameter specifies the permission. The only value for this parameter is SendAs. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 (formerly known as a Windows Live ID) - - 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) - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - RecipientIdParameter - - RecipientIdParameter - - - None - - - AccessRights - - The AccessRights parameter specifies the permission. The only value for this parameter is SendAs. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 (formerly known as a Windows Live ID) - - 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) - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-recipientpermission - - - - - - Complete-MigrationBatch - Complete - MigrationBatch - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Complete-MigrationBatch cmdlet to finalize a migration batch for a local move, cross-forest move, or remote move migration that has successfully finished initial synchronization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - When the finalization process is complete, you can remove the batch by using the Remove-MigrationBatch cmdlet. - If a migration batch has a status of Completed with Errors, you can re-attempt to finalize the failed users. In Exchange Online, use the Start-MigrationBatch cmdlet to retry migration for failed users. In Exchange 2013 or Exchange 2016, use the Complete-MigrationBatch to retry these failed users. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Complete-MigrationBatch - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Complete-MigrationBatch -Identity LocalMove1 -NotificationEmails admin@contoso.com,lucio@contoso.com - - This example completes the migration batch LocalMove1 and sends a notification email message to the specified users. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/complete-migrationbatch - - - - - - Export-MigrationReport - Export - MigrationReport - - This cmdlet is 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 Export-MigrationReport is used by the Exchange migration process to enable an administrator to download a CSV file that contains migration errors for a selected migration batch. This cmdlet isn't run by an administrator in Windows PowerShell. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Export-MigrationReport - - Identity - - This parameter is reserved for internal Microsoft use. - - MigrationReportIdParameter - - MigrationReportIdParameter - - - None - - - CsvStream - - This parameter is reserved for internal Microsoft use. - - Stream - - Stream - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Export-MigrationReport - - Identity - - This parameter is reserved for internal Microsoft use. - - MigrationReportIdParameter - - MigrationReportIdParameter - - - None - - - RowCount - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - StartingRowIndex - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - This parameter is reserved for internal Microsoft use. - - MigrationReportIdParameter - - MigrationReportIdParameter - - - None - - - CsvStream - - This parameter is reserved for internal Microsoft use. - - Stream - - Stream - - - None - - - RowCount - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - StartingRowIndex - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Export-MigrationReport - - There are no examples for using this cmdlet because the values used for the required parameters are generated by and available only to the migration process. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/export-migrationreport - - - - - - Get-CASMailboxPlan - Get - CASMailboxPlan - - This cmdlet is available or functional only in the cloud-based service. - Use the Get-CASMailboxPlan cmdlet to view Client Access services (CAS) mailbox plans in cloud-based organizations. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A CAS mailbox plan is tied to the corresponding mailbox plan that has the same name (and display name). Like mailbox plans, CAS mailbox plans correspond to license types, and are applied to a mailbox when you license the user. The availability of a CAS mailbox plan is determined by your selections when you enroll in the service and the age of your organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CASMailboxPlan - - 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`). - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - IgnoreDefaultScope - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - - - - 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`). - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - IgnoreDefaultScope - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 specified CAS mailbox plan. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-casmailboxplan - - - - - - Get-MailboxImportRequest - Get - MailboxImportRequest - - This cmdlet is available in 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-MailboxImportRequest cmdlet to view the detailed status of an ongoing import request that was initiated using the New-MailboxImportRequest cmdlet. - This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The search criteria for the Get-MailboxImportRequest cmdlet is a Boolean And statement. If you use multiple parameters, you narrow your search and reduce your search results. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxImportRequest - - 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 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 - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-MailboxImportRequest - - BatchName - - The BatchName parameter specifies the name given to a batch import request. - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - Name - - The Name parameter specifies that import requests that have the specified name are returned. - Use this parameter to search on the name that you provided when you created the import request. If you didn't specify a name when the request was created, the default name is MailboxImportX (where X = 0-9). - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - CompletionInProgress and AutoSuspended don't apply to import requests and won't return any information. - - RequestStatus - - RequestStatus - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - Get-MailboxImportRequest - - BatchName - - The BatchName parameter specifies the name given to a batch import request. - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - Name - - The Name parameter specifies that import requests that have the specified name are returned. - Use this parameter to search on the name that you provided when you created the import request. If you didn't specify a name when the request was created, the default name is MailboxImportX (where X = 0-9). - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - CompletionInProgress and AutoSuspended don't apply to import requests and won't return any information. - - RequestStatus - - RequestStatus - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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 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 - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - BatchName - - The BatchName parameter specifies the name given to a batch import request. - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - Name - - The Name parameter specifies that import requests that have the specified name are returned. - Use this parameter to search on the name that you provided when you created the import request. If you didn't specify a name when the request was created, the default name is MailboxImportX (where X = 0-9). - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - CompletionInProgress and AutoSuspended don't apply to import requests and won't return any information. - - RequestStatus - - RequestStatus - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - Get-MailboxImportRequest -BatchName "ImportingDB1PSTs" -Status Completed - - This example returns the status of import requests in the ImportingDB1PSTs batch that completed. - - - - -------------------------- Example 4 -------------------------- - Get-MailboxImportRequest -Name "Recovered" -Suspend $true - - This example returns all import requests that have the name Recovered where the import has been suspended. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboximportrequest - - - - - - Get-MailboxImportRequestStatistics - Get - MailboxImportRequestStatistics - - This cmdlet is available in 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-MailboxImportRequestStatistics cmdlet to view detailed information about import requests. - This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can pipeline the Get-MailboxImportRequestStatistics cmdlet from the Get-MailboxImportRequest cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxImportRequestStatistics - - 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 specified a name when you created the import request, use the following syntax: `Alias\Name`. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - Get-MailboxImportRequestStatistics - - 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 specified a name when you created the import request, use the following syntax: `Alias\Name`. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - 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. - - String - - String - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - Get-MailboxImportRequestStatistics - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - - - 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 specified a name when you created the import request, use the following syntax: `Alias\Name`. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - 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. - - String - - String - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - Get-MailboxImportRequest -Status Failed | Get-MailboxImportRequestStatistics -IncludeReport | Format-List > AllImportReports.txt - - This example returns additional information for all the import requests that have a status of Failed by using the IncludeReport parameter, and then saves the information to the text file AllImportReports.txt. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboximportrequeststatistics - - - - - - Get-MailboxPlan - Get - MailboxPlan - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A mailbox plan is a template that automatically configures mailbox properties. Mailbox plans correspond to license types, and are applied when you license the user. The availability of a mailbox plan is determined by your selections when you enroll in the service and the age of your organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxPlan - - 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 - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - IgnoreDefaultScope - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - OrganizationalUnit - - This parameter is reserved for internal Microsoft use. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - IgnoreDefaultScope - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - OrganizationalUnit - - This parameter is reserved for internal Microsoft use. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxplan - - - - - - Get-MailboxRestoreRequest - Get - MailboxRestoreRequest - - This cmdlet is available in 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-MailboxRestoreRequest cmdlet to view detailed status of an ongoing restore request that was initiated by using the New-MailboxRestoreRequest cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxRestoreRequest - - 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). - You can't use this parameter with the Name parameter. - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-MailboxRestoreRequest - - BatchName - - The BatchName parameter specifies the name given to a batch of restore requests. - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies that any restore request that has the specified name is returned. - Use this parameter to search on the name you provided when you created the restore request. - 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). - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - RequestStatus - - RequestStatus - - - None - - - 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. - - Boolean - - Boolean - - - None - - - TargetMailbox - - 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. - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - - - - 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). - You can't use this parameter with the Name parameter. - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - BatchName - - The BatchName parameter specifies the name given to a batch of restore requests. - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies that any restore request that has the specified name is returned. - Use this parameter to search on the name you provided when you created the restore request. - 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). - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - RequestStatus - - RequestStatus - - - None - - - 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. - - Boolean - - Boolean - - - None - - - TargetMailbox - - 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. - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MailboxRestoreRequest -Identity "ayla\MailboxRestore" - - This example returns the status of the in-progress and queued restore request with the identity ayla\MailboxRestore. - - - - -------------------------- Example 2 -------------------------- - 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 -------------------------- - 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 -------------------------- - Get-MailboxRestoreRequest -Name "RestoreToMBD01" -Suspend $true - - This example returns all restore requests that have the name RestoreToMBD01 where the restore request has been suspended. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxrestorerequest - - - - - - Get-MailboxRestoreRequestStatistics - Get - MailboxRestoreRequestStatistics - - This cmdlet is available in 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-MailboxRestoreRequestStatistics cmdlet to view detailed information about restore requests. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxRestoreRequestStatistics - - 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). - You can't use this parameter with the MRSInstance or RequestQueue parameters. - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - Get-MailboxRestoreRequestStatistics - - 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). - You can't use this parameter with the MRSInstance or RequestQueue parameters. - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - - Get-MailboxRestoreRequestStatistics - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - - - 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). - You can't use this parameter with the MRSInstance or RequestQueue parameters. - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - Get-MailboxRestoreRequest -Status Failed | Get-MailboxRestoreRequestStatistics -IncludeReport | Format-List > C:\Reports\AllRestoreReports.txt - - This example returns additional information for all the restore requests that have a status of Failed by using the IncludeReport parameter and then saves the information to the text file C:\Reports\AllRestoreReports.txt. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxrestorerequeststatistics - - - - - - Get-MigrationBatch - Get - MigrationBatch - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.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. - - - - Get-MigrationBatch - - 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. - - String - - String - - - None - - - 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. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 - - Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus - - Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus - - - None - - - - Get-MigrationBatch - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 - - Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus - - Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus - - - None - - - - - - 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. - - String - - String - - - None - - - 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. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 - - Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus - - Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-migrationbatch - - - - - - Get-MigrationConfig - Get - MigrationConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MigrationConfig - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MigrationConfig - - This example retrieves the settings for the migration configuration. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-migrationconfig - - - - - - Get-MigrationEndpoint - Get - MigrationEndpoint - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/Exchange/recipients/mailbox-moves)- Manage on-premises mailbox moves in Exchange Server (https://docs.microsoft.com/Exchange/architecture/mailbox-servers/manage-mailbox-moves)You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MigrationEndpoint - - Identity - - The Identity parameter specifies the name of the migration endpoint you want to retrieve settings for. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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. - - String - - String - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - Get-MigrationEndpoint - - 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. - - String - - String - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 - - MigrationType - - MigrationType - - - None - - - - - - 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. - - String - - String - - - None - - - Identity - - The Identity parameter specifies the name of the migration endpoint you want to retrieve settings for. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 - - MigrationType - - MigrationType - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MigrationEndpoint -Identity OnboardingME01 - - This example retrieves the settings for the migration endpoint, OnboardingME01. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-migrationendpoint - - - - - - Get-MigrationStatistics - Get - MigrationStatistics - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MigrationStatistics - - 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. - - String - - String - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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. - - String - - String - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MigrationStatistics - - This example returns the default statistics for the migration batches. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-migrationstatistics - - - - - - Get-MigrationUser - Get - MigrationUser - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MigrationUser - - MailboxGuid - - The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the migration information. - - Guid - - Guid - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-MigrationUser - - BatchId - - The BatchId parameter specifies the name of the migration batch for which you want to return users. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - MigrationUserStatus - - MigrationUserStatus - - - None - - - 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 - - MigrationUserStatusSummary - - MigrationUserStatusSummary - - - None - - - - Get-MigrationUser - - Identity - - The Identity parameter specifies the particular user that you want to retrieve information about. The Identity parameter is represented as an email address. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - MailboxGuid - - The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the migration information. - - Guid - - Guid - - - None - - - BatchId - - The BatchId parameter specifies the name of the migration batch for which you want to return users. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Identity - - The Identity parameter specifies the particular user that you want to retrieve information about. The Identity parameter is represented as an email address. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - MigrationUserStatus - - MigrationUserStatus - - - None - - - 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 - - MigrationUserStatusSummary - - MigrationUserStatusSummary - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-migrationuser - - - - - - Get-MigrationUserStatistics - Get - MigrationUserStatistics - - This cmdlet is available in 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-MigrationUserStatistics cmdlet to view detailed information about the migration requested for a specific user. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MigrationUserStatistics - - Identity - - The Identity parameter specifies the user that you want to retrieve migration information about. Use an email address as the value for this parameter. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - 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. - - String - - String - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - - SwitchParameter - - - False - - - IncludeSkippedItems - - The IncludeSkippedItems switch specifies whether to include skipped items for the user. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - LimitSkippedItemsTo - - The LimitSkippedItemsTo parameter specifies the maximum number of skipped items to display information about in the SkippedItems property in command output. For example, if this parameter is set to 5, the cmdlet returns information for up to five skipped items for the specified user, even if there are more than five skipped items. - - Int32 - - Int32 - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - SkipSubscription - - The SkipSubscription switch specifies whether to skip loading the subscription for the user. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the user that you want to retrieve migration information about. Use an email address as the value for this parameter. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - 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. - - String - - String - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - SwitchParameter - - SwitchParameter - - - False - - - IncludeSkippedItems - - The IncludeSkippedItems switch specifies whether to include skipped items for the user. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - LimitSkippedItemsTo - - The LimitSkippedItemsTo parameter specifies the maximum number of skipped items to display information about in the SkippedItems property in command output. For example, if this parameter is set to 5, the cmdlet returns information for up to five skipped items for the specified user, even if there are more than five skipped items. - - Int32 - - Int32 - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - SkipSubscription - - The SkipSubscription switch specifies whether to skip loading the subscription for the user. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 - - This example displays results information in the SkippedItems property for a maximum of 20 skipped items. - - - - -------------------------- Example 4 -------------------------- - Get-MigrationUser -BatchId StagedBatch1 | Get-MigrationUserStatistics - - This example displays detailed information about users in the migration batch named StagedBatch1. - - - - -------------------------- Example 5 -------------------------- - Get-MigrationUser | Get-MigrationUserStatistics - - This example displays detailed information about users from all current migration batches. - - - - -------------------------- Example 6 -------------------------- - Get-MigrationUserStatistics -Identity davidp@corp.contoso.com -Diagnostic | Format-List Status,Error,DiagnosticInfo - - In on-premises Exchange, this example uses the Diagnostic parameter to display detailed troubleshooting information about the migration for the user. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-migrationuserstatistics - - - - - - Get-MoveRequest - Get - MoveRequest - - This cmdlet is available in 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-MoveRequest cmdlet to view the detailed status of an ongoing asynchronous mailbox move that was initiated by using the New-MoveRequest cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The search criteria for the Get-MoveRequest cmdlet is a Boolean And statement. If you use multiple parameters, it narrows your search and reduces your search results. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MoveRequest - - 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: - - 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 - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-MoveRequest - - BatchName - - The BatchName parameter specifies the name that was given to a batch move request. - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - Flags - - 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 - - RequestFlags - - RequestFlags - - - None - - - MoveStatus - - 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. - - RequestStatus - - RequestStatus - - - None - - - Offline - - The Offline parameter specifies whether to return mailboxes that are being moved in offline mode. This parameter accepts $true or $false. - You can't use this parameter with the Identity parameter. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - RemoteHostName - - The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. - You can't use this parameter with the Identity parameter. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - Suspend - - The Suspend parameter specifies whether to return mailboxes with moves that have been suspended. This parameter accepts $true or $false. - You can't use this parameter with the Identity parameter. - - Boolean - - Boolean - - - None - - - SuspendWhenReadyToComplete - - The SuspendWhenReadytoComplete parameter specifies whether to return mailboxes that have been moved with the New-MoveRequest command and its SuspendWhenReadyToComplete switch. This parameter accepts $true or $false. - You can't use this parameter with the Identity parameter. - - Boolean - - Boolean - - - None - - - - - - 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: - - 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 - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - BatchName - - The BatchName parameter specifies the name that was given to a batch move request. - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - Flags - - 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 - - RequestFlags - - RequestFlags - - - None - - - MoveStatus - - 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. - - RequestStatus - - RequestStatus - - - None - - - Offline - - The Offline parameter specifies whether to return mailboxes that are being moved in offline mode. This parameter accepts $true or $false. - You can't use this parameter with the Identity parameter. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - RemoteHostName - - The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. - You can't use this parameter with the Identity parameter. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - Suspend - - The Suspend parameter specifies whether to return mailboxes with moves that have been suspended. This parameter accepts $true or $false. - You can't use this parameter with the Identity parameter. - - Boolean - - Boolean - - - None - - - SuspendWhenReadyToComplete - - The SuspendWhenReadytoComplete parameter specifies whether to return mailboxes that have been moved with the New-MoveRequest command and its SuspendWhenReadyToComplete switch. This parameter accepts $true or $false. - You can't use this parameter with the Identity parameter. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Get-MoveRequest -MoveStatus InProgress -TargetDatabase DB05 - - This example retrieves the status of ongoing mailbox moves to the target database DB05. - - - - -------------------------- Example 3 -------------------------- - Get-MoveRequest -BatchName "FromDB01ToDB02" -MoveStatus CompletedWithWarning - - This example retrieves the status of move requests in the FromDB01ToDB02 batch that completed, but had warnings. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-moverequest - - - - - - Get-MoveRequestStatistics - Get - MoveRequestStatistics - - This cmdlet is available in 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-MoveRequestStatistics cmdlet to view detailed information about move requests. - Some of the failure messages that are returned by this cmdlet are temporary and don't indicate that a request has actually failed. If the Status value is Queued or InProgress, then the request is proceeding normally. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MoveRequestStatistics - - 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. - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - ReportOnly - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - Get-MoveRequestStatistics - - 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. - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - 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: - - ShowTimeline - - ShowTimeslot - - Verbose - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - ReportOnly - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - Get-MoveRequestStatistics - - 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. - - - SwitchParameter - - - False - - - ReportOnly - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - - - 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. - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - 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: - - ShowTimeline - - ShowTimeslot - - Verbose - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - ReportOnly - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-moverequeststatistics - - - - - - Get-PublicFolderMailboxMigrationRequest - Get - PublicFolderMailboxMigrationRequest - - This cmdlet is available in 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-PublicFolderMailboxMigrationRequest cmdlet to view the status of individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-PublicFolderMailboxMigrationRequest cmdlet displays the following properties by default. - - Name: The name assigned by the system to a specific mailbox migration job. - - TargetMailbox: The mailbox being migrated. - - Status: The current status of the job. - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PublicFolderMailboxMigrationRequest - - 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:<Batch name provided at batch creation>`. - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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<GUID>` (for example, `PublicFolderMailboxMigration2ffdef13-01b9-4586-af2b-d5a5482010a8`). - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - RequestStatus - - RequestStatus - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - Get-PublicFolderMailboxMigrationRequest - - Identity - - The Identity parameter specifies the public folder mailbox migration request that you want to view. The value uses the syntax: `\PublicFolderMailboxMigration<GUID>` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). - You can't use this parameter with the following parameters: - - BatchName - - HighPriority - - Name - - RequestQueue - - Suspend - - Status - - PublicFolderMailboxMigrationRequestIdParameter - - PublicFolderMailboxMigrationRequestIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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:<Batch name provided at batch creation>`. - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - Identity - - The Identity parameter specifies the public folder mailbox migration request that you want to view. The value uses the syntax: `\PublicFolderMailboxMigration<GUID>` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). - You can't use this parameter with the following parameters: - - BatchName - - HighPriority - - Name - - RequestQueue - - Suspend - - Status - - PublicFolderMailboxMigrationRequestIdParameter - - PublicFolderMailboxMigrationRequestIdParameter - - - None - - - 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<GUID>` (for example, `PublicFolderMailboxMigration2ffdef13-01b9-4586-af2b-d5a5482010a8`). - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - RequestStatus - - RequestStatus - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-PublicFolderMailboxMigrationRequest - - This example returns information about all migration requests. - - - - -------------------------- Example 2 -------------------------- - Get-PublicFolderMailboxMigrationRequest -HighPriority $true - - In on-premises Exchange, this example returns all migration requests that have a priority value of High, Higher, Highest or Emergency. - - - - -------------------------- Example 3 -------------------------- - Get-PublicFolderMailboxMigrationRequest | ?{$_.TargetMailbox -eq $null} - - This example returns public folder mailbox migration requests that don't have a target mailbox. - - - - -------------------------- Example 4 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequest - - - - - - Get-PublicFolderMailboxMigrationRequestStatistics - Get - PublicFolderMailboxMigrationRequestStatistics - - This cmdlet is available in 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-PublicFolderMailboxMigrationRequestStatistics cmdlet to view the detailed status of individual jobs in a public folder migration batch created using New-MigrationBatch cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PublicFolderMailboxMigrationRequestStatistics - - Identity - - The Identity parameter specifies the public folder mailbox migration request. The default identity value is `\PublicFolderMailboxMigration<UniqueIdentifier>` (for example, `PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). - You can't use this parameter with the RequestQueue and RequestGuid parameters. - - PublicFolderMailboxMigrationRequestIdParameter - - PublicFolderMailboxMigrationRequestIdParameter - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - Get-PublicFolderMailboxMigrationRequestStatistics - - Identity - - The Identity parameter specifies the public folder mailbox migration request. The default identity value is `\PublicFolderMailboxMigration<UniqueIdentifier>` (for example, `PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). - You can't use this parameter with the RequestQueue and RequestGuid parameters. - - PublicFolderMailboxMigrationRequestIdParameter - - PublicFolderMailboxMigrationRequestIdParameter - - - None - - - 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. - - String - - String - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the public folder mailbox migration request. The default identity value is `\PublicFolderMailboxMigration<UniqueIdentifier>` (for example, `PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). - You can't use this parameter with the RequestQueue and RequestGuid parameters. - - PublicFolderMailboxMigrationRequestIdParameter - - PublicFolderMailboxMigrationRequestIdParameter - - - None - - - 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. - - String - - String - - - None - - - IncludeReport - - The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-PublicFolderMailboxMigrationRequestStatistics -Identity \PublicFolderMailboxMigration4ce124b0-d760-4364-94bc-40d7918fd171 - - This example uses the Identity parameter to return information about the specified target job. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequeststatistics - - - - - - Get-RecipientPermission - Get - RecipientPermission - - This cmdlet is available only in the cloud-based service. - Use the Get-RecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization. Note : In Exchange Online PowerShell, we recommend that you use the Get-EXORecipientPermission cmdlet instead of this cmdlet. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When a user is given SendAs permission to another user or group, the user can send messages that appear to come from the other user or group. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RecipientPermission - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - AccessRights - - The AccessRights parameter filters the results by permission. The only valid value for this parameter is SendAs. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ReadFromDomainController - - The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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: - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - You need to use this parameter with the Identity parameter. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - AccessRights - - The AccessRights parameter filters the results by permission. The only valid value for this parameter is SendAs. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ReadFromDomainController - - The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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: - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - You need to use this parameter with the Identity parameter. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-recipientpermission - - - - - - New-MailboxImportRequest - New - MailboxImportRequest - - This cmdlet is available in 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://docs.microsoft.com/microsoft-365/compliance/use-network-upload-to-import-pst-files). - This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - 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. - - - - New-MailboxImportRequest - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxLocationIdParameter - - MailboxLocationIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - FAICopyOption - - FAICopyOption - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 (Exchage 2016 or later) - - UpdateFromSource (Exchange 2016 or later) - - ConflictResolutionOption - - ConflictResolutionOption - - - None - - - 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://docs.microsoft.com/windows/win32/intl/code-page-identifiers)topic. - - Int32 - - Int32 - - - None - - - 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 - - - SwitchParameter - - - 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 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. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - 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. - - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - MigrationMailbox - - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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`. - - String - - String - - - None - - - 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. - - RequestPriority - - RequestPriority - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - SkipMerging - - The SkipMerging parameter specifies steps in the import that should be skipped. This parameter is used primarily for debugging purposes. - - SkippableMergeComponent[] - - SkippableMergeComponent[] - - - None - - - SourceEndpoint - - This parameter is reserved for internal Microsoft use. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxLocationIdParameter - - MailboxLocationIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - FAICopyOption - - FAICopyOption - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 (Exchage 2016 or later) - - UpdateFromSource (Exchange 2016 or later) - - ConflictResolutionOption - - ConflictResolutionOption - - - None - - - 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://docs.microsoft.com/windows/win32/intl/code-page-identifiers)topic. - - Int32 - - Int32 - - - None - - - 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 - - SwitchParameter - - SwitchParameter - - - 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 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. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - MigrationMailbox - - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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`. - - String - - String - - - None - - - 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. - - RequestPriority - - RequestPriority - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - SkipMerging - - The SkipMerging parameter specifies steps in the import that should be skipped. This parameter is used primarily for debugging purposes. - - SkippableMergeComponent[] - - SkippableMergeComponent[] - - - None - - - SourceEndpoint - - This parameter is reserved for internal Microsoft use. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mailboximportrequest - - - - - - New-MailboxRestoreRequest - New - MailboxRestoreRequest - - This cmdlet is available in 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 inative mailbox (https://docs.microsoft.com/microsoft-365/compliance/restore-an-inactive-mailbox). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MailboxRestoreRequest - - RemoteCredential - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - PSCredential - - PSCredential - - - None - - - RemoteDatabaseGuid - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Guid - - Guid - - - None - - - RemoteHostName - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - RemoteRestoreType - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - RemoteRestoreType - - RemoteRestoreType - - - None - - - 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. - - MailboxLocationIdParameter - - MailboxLocationIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - FAICopyOption - - FAICopyOption - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - ConflictResolutionOption - - ConflictResolutionOption - - - KeepSourceItem - - - 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 - - - SwitchParameter - - - 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 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. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - TargetIsArchive - - The TargetIsArchive parameter specifies that the content is restored into the specified target mailbox's archive. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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) - - TargetTypeComponent - - TargetTypeComponent - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MailboxRestoreRequest - - 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. - - SourceMailbox - - SourceMailbox - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - FAICopyOption - - FAICopyOption - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - ConflictResolutionOption - - ConflictResolutionOption - - - KeepSourceItem - - - 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 - - - SwitchParameter - - - 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 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. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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). - - String - - String - - - None - - - SourceIsArchive - - The SourceIsArchive switch specifies that the source mailbox is an archive mailbox. You can use this switch only with the SourceMailbox parameter. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - TargetIsArchive - - The TargetIsArchive parameter specifies that the content is restored into the specified target mailbox's archive. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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) - - TargetTypeComponent - - TargetTypeComponent - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MailboxRestoreRequest - - 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. - - MailboxLocationIdParameter - - MailboxLocationIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - FAICopyOption - - FAICopyOption - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - ConflictResolutionOption - - ConflictResolutionOption - - - KeepSourceItem - - - 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 - - - SwitchParameter - - - 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 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. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - TargetIsArchive - - The TargetIsArchive parameter specifies that the content is restored into the specified target mailbox's archive. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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) - - TargetTypeComponent - - TargetTypeComponent - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - RemoteCredential - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - PSCredential - - PSCredential - - - None - - - RemoteDatabaseGuid - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Guid - - Guid - - - None - - - RemoteHostName - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - RemoteRestoreType - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - RemoteRestoreType - - RemoteRestoreType - - - None - - - 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. - - SourceMailbox - - SourceMailbox - - - None - - - 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. - - MailboxLocationIdParameter - - MailboxLocationIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - FAICopyOption - - FAICopyOption - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 - - ConflictResolutionOption - - ConflictResolutionOption - - - KeepSourceItem - - - 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 - - SwitchParameter - - SwitchParameter - - - 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 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. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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). - - String - - String - - - None - - - SourceIsArchive - - The SourceIsArchive switch specifies that the source mailbox is an archive mailbox. You can use this switch only with the SourceMailbox parameter. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - TargetIsArchive - - The TargetIsArchive parameter specifies that the content is restored into the specified target mailbox's archive. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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) - - TargetTypeComponent - - TargetTypeComponent - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-Mailbox -SoftDeletedMailbox "User Name" | Format-List ExchangeGUID -New-MailboxRestoreRequest -SourceMailbox "ExchangeGUID" -TargetMailbox "User Name" -AllLegacyDNMismatch - - In Exchange Online, this example uses the Get-Mailbox cmdlet to find the ExchangeGUID value of the mailbox, which is required to restore the mailbox contents. - - - - -------------------------- Example 2 -------------------------- - 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 3 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mailboxrestorerequest - - - - - - New-MigrationBatch - New - MigrationBatch - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - - G Suite migration: This onboarding migration type migrates mailbox data from a G Suite organization to Exchange Online. For a G Suite migration, you must first provision mail users (or mailboxes) in Exchange Online before you can migrate mailbox data. For more information, see Example 10. - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MigrationBatch - - 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. - - String - - String - - - None - - - CSVData - - The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see CSV files for mailbox migration (https://docs.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). - 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"))`. 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. - - Byte[] - - Byte[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - MigrationWorkflowControlFlags - - MigrationWorkflowControlFlags - - - None - - - - New-MigrationBatch - - 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. - - String - - String - - - None - - - CSVData - - The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see CSV files for mailbox migration (https://docs.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). - 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"))`. 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. - - Byte[] - - Byte[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationBatch - - 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. - - String - - String - - - None - - - CSVData - - The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see CSV files for mailbox migration (https://docs.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). - 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"))`. 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. - - Byte[] - - Byte[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - String - - String - - - None - - - 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. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationBatch - - 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. - - String - - String - - - None - - - CSVData - - The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see CSV files for mailbox migration (https://docs.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). - 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"))`. 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. - - Byte[] - - Byte[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - PublicFolderToUnifiedGroup - - This parameter is available or 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - - SwitchParameter - - - 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. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationBatch - - 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. - - String - - String - - - None - - - CSVData - - The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see CSV files for mailbox migration (https://docs.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). - 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"))`. 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. - - Byte[] - - Byte[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ContentFilter - - This parameter is available only in the cloud-based service. - The ContentFilter parameter uses OPath filter syntax to filter the messages by Received date. 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. - - String - - String - - - None - - - 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://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - - SwitchParameter - - - False - - - ExcludeFolders - - This parameter is available only in the cloud-based service. - For an IMAP migration or G Suite 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 G Suite 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: - `<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 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - IncludeFolders - - This parameter is available only in the cloud-based service. - For an IMAP migration or G Suite migration, the IncludeFolders parameter specifies mailbox folders that you want to migrate from the on-premises email system to the cloud-based mailboxes. Use folder names relative to the IMAP root on the source mail server or use label names for G Suite migration. 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 G Suite 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: - `<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 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - String - - String - - - None - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - MigrationWorkflowControlFlags - - MigrationWorkflowControlFlags - - - None - - - - New-MigrationBatch - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - - SwitchParameter - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationBatch - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - - SwitchParameter - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationBatch - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - - SwitchParameter - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - - New-MigrationBatch - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - - SwitchParameter - - - 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. - - DateTime - - DateTime - - - None - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - CSVData - - The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see CSV files for mailbox migration (https://docs.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). - 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"))`. 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. - - Byte[] - - Byte[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ContentFilter - - This parameter is available only in the cloud-based service. - The ContentFilter parameter uses OPath filter syntax to filter the messages by Received date. 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. - - String - - String - - - None - - - 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://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ExcludeFolders - - This parameter is available only in the cloud-based service. - For an IMAP migration or G Suite 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 G Suite 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: - `<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 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - IncludeFolders - - This parameter is available only in the cloud-based service. - For an IMAP migration or G Suite migration, the IncludeFolders parameter specifies mailbox folders that you want to migrate from the on-premises email system to the cloud-based mailboxes. Use folder names relative to the IMAP root on the source mail server or use label names for G Suite migration. 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 G Suite 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: - `<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 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - PublicFolderToUnifiedGroup - - This parameter is available or 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. - - SwitchParameter - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - String - - String - - - None - - - 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. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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`. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - MigrationWorkflowControlFlags - - MigrationWorkflowControlFlags - - - None - - - 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. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 8 -------------------------- - $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")) -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 -------------------------- - $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")) -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 -------------------------- - $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 G Suite 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-migrationbatch - - - - - - New-MigrationEndpoint - New - MigrationEndpoint - - This cmdlet is available in 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 G Suite migrations. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - - G Suite migration: Migration mailbox data from a G Suite tenant to Exchange Online. For a G Suite migration, you must first create cloud-based mail users or mailboxes before you migrate mailbox data. G Suite migrations require the use of a Gmail endpoint. - - Moving mailboxes between different servers or databases within a single on-premises Exchange forest (called a local move) doesn't require a migration endpoint. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MigrationMailboxPermission - - MigrationMailboxPermission - - - None - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - Compliance - - The Compliance switch specifies that the endpoint type is compliance. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - - SwitchParameter - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - MigrationMailboxPermission - - MigrationMailboxPermission - - - None - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - PublicFolder - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - PublicFolderDatabaseServerLegacyDN - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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. - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - PublicFolder - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - PublicFolderDatabaseServerLegacyDN - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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. - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - PSTImport - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - Gmail - - This parameter is available only in the cloud-based service. - The Gmail switch specifies the type of endpoint for G Suite migrations. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes(<path of the JSON file>))`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json"))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MigrationEndpoint - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - IMAPSecurityMechanism - - IMAPSecurityMechanism - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Compliance - - The Compliance switch specifies that the endpoint type is compliance. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Gmail - - This parameter is available only in the cloud-based service. - The Gmail switch specifies the type of endpoint for G Suite migrations. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - PSTImport - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - PublicFolder - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - PublicFolderDatabaseServerLegacyDN - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes(<path of the JSON file>))`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json"))`. - - Byte[] - - Byte[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - MigrationMailboxPermission - - MigrationMailboxPermission - - - None - - - MaxConcurrentIncrementalSyncs - - The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed per endpoint. The default value is 20. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - IMAPSecurityMechanism - - IMAPSecurityMechanism - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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\username 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-migrationendpoint - - - - - - New-MoveRequest - New - MoveRequest - - This cmdlet is available in 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-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. Note : After April 15, 2020, you can'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. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MoveRequest - - 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 - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - Outbound - - The Outbound switch specifies that this mailbox move is a cross-forest move and is being initiated from the source forest. You don't need to specify a value with this switch. - You can't use this switch with the Remote switch. - - - SwitchParameter - - - False - - - RemoteCredential - - The RemoteCredential parameter specifies the username and password of an administrator who has permission to perform the mailbox move. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - RemoteGlobalCatalog - - The RemoteGlobalCatalog parameter specifies the fully qualified domain name (FQDN) of the global catalog server for the remote forest. - - Fqdn - - Fqdn - - - None - - - RemoteHostName - - The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. - - Fqdn - - Fqdn - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - - SwitchParameter - - - False - - - ArchiveDomain - - The ArchiveDomain parameter specifies the FQDN of the external domain to which you're moving the archive. This parameter is used for moving the archive to a cloud-based service. - - String - - String - - - None - - - ArchiveOnly - - The ArchiveOnly switch specifies that you're moving only the personal archive associated with the mailbox. - You can't use this switch with the PrimaryOnly switch. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet. - - String - - String - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceOffline - - 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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 Server: Message size limits in Exchange Server (https://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - False - - - PrimaryOnly - - The PrimaryOnly switch specifies that the command should only move the primary mailbox (the personal archive isn't moved). You don't need to specify a value with this switch. - You use this switch only if the user has a personal archive that you don't want to move. If the user doesn't have personal archive, don't use this switch. - You can't use this parameter with the ArchiveOnly parameter. - - - SwitchParameter - - - False - - - Protect - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - RemoteArchiveTargetDatabase - - The RemoteArchiveTargetDatabase parameter specifies the name of the target database in the remote forest to which you're moving the personal archive. Use this parameter when moving users with archives from the local forest to a remote forest. For moves from a remote forest to the local forest, use the ArchiveTargetDatabase parameter. - If you use this parameter, you must specify the Remote or RemoteLegacy parameter. - - String - - String - - - None - - - RemoteTargetDatabase - - The RemoteTargetDatabase parameter specifies the name of the target database in the remote forest. Use this parameter when moving mailboxes from the local forest to a remote forest. For moves from a remote forest to the local forest, use the TargetDatabase parameter. - If you use this parameter, you must specify the Remote or RemoteLegacy parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMoveComponent[] - - SkippableMoveComponent[] - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - You can use this switch to test a mailbox's readiness to be moved, and to view any errors that will occur without adding the mailbox to the move request queue. - - - SwitchParameter - - - False - - - - New-MoveRequest - - 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 - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - Outbound - - The Outbound switch specifies that this mailbox move is a cross-forest move and is being initiated from the source forest. You don't need to specify a value with this switch. - You can't use this switch with the Remote switch. - - - SwitchParameter - - - False - - - RemoteTenant - - This parameter is available only in the cloud-based service. - PARAMVALUE: SmtpDomain - - SmtpDomain - - SmtpDomain - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet. - - String - - String - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceOffline - - 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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 Server: Message size limits in Exchange Server (https://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - False - - - Protect - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMoveComponent[] - - SkippableMoveComponent[] - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - You can use this switch to test a mailbox's readiness to be moved, and to view any errors that will occur without adding the mailbox to the move request queue. - - - SwitchParameter - - - False - - - - New-MoveRequest - - 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 - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - Remote - - The Remote switch specifies that the move is outside of your organization and is being initiated from the target forest. You don't need to specify a value with this switch. - You can't use this switch with the Outbound switch. - - - SwitchParameter - - - False - - - RemoteCredential - - The RemoteCredential parameter specifies the username and password of an administrator who has permission to perform the mailbox move. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - RemoteGlobalCatalog - - The RemoteGlobalCatalog parameter specifies the fully qualified domain name (FQDN) of the global catalog server for the remote forest. - - Fqdn - - Fqdn - - - None - - - RemoteHostName - - The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. - - Fqdn - - Fqdn - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - - SwitchParameter - - - False - - - ArchiveDomain - - The ArchiveDomain parameter specifies the FQDN of the external domain to which you're moving the archive. This parameter is used for moving the archive to a cloud-based service. - - String - - String - - - None - - - ArchiveOnly - - The ArchiveOnly switch specifies that you're moving only the personal archive associated with the mailbox. - You can't use this switch with the PrimaryOnly switch. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet. - - String - - String - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceOffline - - 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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 Server: Message size limits in Exchange Server (https://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - False - - - PrimaryOnly - - The PrimaryOnly switch specifies that the command should only move the primary mailbox (the personal archive isn't moved). You don't need to specify a value with this switch. - You use this switch only if the user has a personal archive that you don't want to move. If the user doesn't have personal archive, don't use this switch. - You can't use this parameter with the ArchiveOnly parameter. - - - SwitchParameter - - - False - - - Protect - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - RemoteTargetDatabase - - The RemoteTargetDatabase parameter specifies the name of the target database in the remote forest. Use this parameter when moving mailboxes from the local forest to a remote forest. For moves from a remote forest to the local forest, use the TargetDatabase parameter. - If you use this parameter, you must specify the Remote or RemoteLegacy parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMoveComponent[] - - SkippableMoveComponent[] - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - You can use this switch to test a mailbox's readiness to be moved, and to view any errors that will occur without adding the mailbox to the move request queue. - - - SwitchParameter - - - False - - - - New-MoveRequest - - 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 - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - Remote - - The Remote switch specifies that the move is outside of your organization and is being initiated from the target forest. You don't need to specify a value with this switch. - You can't use this switch with the Outbound switch. - - - SwitchParameter - - - False - - - RemoteTenant - - This parameter is available only in the cloud-based service. - PARAMVALUE: SmtpDomain - - SmtpDomain - - SmtpDomain - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet. - - String - - String - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceOffline - - 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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 Server: Message size limits in Exchange Server (https://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - False - - - Protect - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMoveComponent[] - - SkippableMoveComponent[] - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - You can use this switch to test a mailbox's readiness to be moved, and to view any errors that will occur without adding the mailbox to the move request queue. - - - SwitchParameter - - - False - - - - New-MoveRequest - - 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 - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - RemoteCredential - - The RemoteCredential parameter specifies the username and password of an administrator who has permission to perform the mailbox move. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - RemoteGlobalCatalog - - The RemoteGlobalCatalog parameter specifies the fully qualified domain name (FQDN) of the global catalog server for the remote forest. - - Fqdn - - Fqdn - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet. - - String - - String - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceOffline - - 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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 Server: Message size limits in Exchange Server (https://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - False - - - Protect - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMoveComponent[] - - SkippableMoveComponent[] - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - You can use this switch to test a mailbox's readiness to be moved, and to view any errors that will occur without adding the mailbox to the move request queue. - - - SwitchParameter - - - False - - - - New-MoveRequest - - 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 - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - ArchiveOnly - - The ArchiveOnly switch specifies that you're moving only the personal archive associated with the mailbox. - You can't use this switch with the PrimaryOnly switch. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet. - - String - - String - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceOffline - - 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. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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 Server: Message size limits in Exchange Server (https://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - False - - - PrimaryOnly - - The PrimaryOnly switch specifies that the command should only move the primary mailbox (the personal archive isn't moved). You don't need to specify a value with this switch. - You use this switch only if the user has a personal archive that you don't want to move. If the user doesn't have personal archive, don't use this switch. - You can't use this parameter with the ArchiveOnly parameter. - - - SwitchParameter - - - False - - - Protect - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMoveComponent[] - - SkippableMoveComponent[] - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - You can use this switch to test a mailbox's readiness to be moved, and to view any errors that will occur without adding the mailbox to the move request queue. - - - SwitchParameter - - - False - - - - - - 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 - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - Outbound - - The Outbound switch specifies that this mailbox move is a cross-forest move and is being initiated from the source forest. You don't need to specify a value with this switch. - You can't use this switch with the Remote switch. - - SwitchParameter - - SwitchParameter - - - False - - - Remote - - The Remote switch specifies that the move is outside of your organization and is being initiated from the target forest. You don't need to specify a value with this switch. - You can't use this switch with the Outbound switch. - - SwitchParameter - - SwitchParameter - - - False - - - RemoteCredential - - The RemoteCredential parameter specifies the username and password of an administrator who has permission to perform the mailbox move. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - RemoteGlobalCatalog - - The RemoteGlobalCatalog parameter specifies the fully qualified domain name (FQDN) of the global catalog server for the remote forest. - - Fqdn - - Fqdn - - - None - - - RemoteHostName - - The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. - - Fqdn - - Fqdn - - - None - - - RemoteTenant - - This parameter is available only in the cloud-based service. - PARAMVALUE: SmtpDomain - - SmtpDomain - - SmtpDomain - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ArchiveDomain - - The ArchiveDomain parameter specifies the FQDN of the external domain to which you're moving the archive. This parameter is used for moving the archive to a cloud-based service. - - String - - String - - - None - - - ArchiveOnly - - The ArchiveOnly switch specifies that you're moving only the personal archive associated with the mailbox. - You can't use this switch with the PrimaryOnly switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies a descriptive name for moving a batch of mailboxes. You can then use the name in the BatchName parameter as a search string when you use the Get-MoveRequest cmdlet. - - String - - String - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceOffline - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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 Server: Message size limits in Exchange Server (https://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - PrimaryOnly - - The PrimaryOnly switch specifies that the command should only move the primary mailbox (the personal archive isn't moved). You don't need to specify a value with this switch. - You use this switch only if the user has a personal archive that you don't want to move. If the user doesn't have personal archive, don't use this switch. - You can't use this parameter with the ArchiveOnly parameter. - - SwitchParameter - - SwitchParameter - - - False - - - Protect - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - RemoteArchiveTargetDatabase - - The RemoteArchiveTargetDatabase parameter specifies the name of the target database in the remote forest to which you're moving the personal archive. Use this parameter when moving users with archives from the local forest to a remote forest. For moves from a remote forest to the local forest, use the ArchiveTargetDatabase parameter. - If you use this parameter, you must specify the Remote or RemoteLegacy parameter. - - String - - String - - - None - - - RemoteTargetDatabase - - The RemoteTargetDatabase parameter specifies the name of the target database in the remote forest. Use this parameter when moving mailboxes from the local forest to a remote forest. For moves from a remote forest to the local forest, use the TargetDatabase parameter. - If you use this parameter, you must specify the Remote or RemoteLegacy parameter. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMoveComponent[] - - SkippableMoveComponent[] - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - You can use this switch to test a mailbox's readiness to be moved, and to view any errors that will occur without adding the mailbox to the move request queue. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - New-MoveRequest -Identity 'tony@alpineskihouse.com' -TargetDatabase "DB01" - - This example moves Tony Smith's mailbox to the new database DB01. - - - - -------------------------- Example 3 -------------------------- - Get-Mailbox -Database DB01 | New-MoveRequest -TargetDatabase DB02 -BatchName "DB01toDB02" - - This example creates a batch move request for all mailboxes on the database DB01 and moves them to the database DB02 with the BatchName parameter value DB01toDB02. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-moverequest - - - - - - Remove-MailboxImportRequest - Remove - MailboxImportRequest - - This cmdlet is available in 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-MailboxImportRequest cmdlet to remove fully or partially completed import requests. Completed import requests aren't automatically cleared. Requests need to be removed by using the Remove-MailboxImportRequest cmdlet. Multiple import requests can exist against the same mailbox if you provide a distinct import request name. - NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see Use network upload to import PST files (https://docs.microsoft.com/microsoft-365/compliance/use-network-upload-to-import-pst-files). - This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - Removing a partially completed import request removes the request from the Microsoft Exchange Mailbox Replication service (MRS) job queue. Any import progress that was made until the removal won't be reverted. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The parameter set that requires the Identity parameter allows you to remove a fully or partially completed import request. - The parameter set that requires the RequestGuid and RequestQueue parameters is used for MRS debugging purposes only. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MailboxImportRequest - - 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`. - You can't use this parameter with the RequestGuid parameter. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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`. - You can't use this parameter with the RequestGuid parameter. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MailboxImportRequest -Identity "Ayla\MailboxImport1" - - This example removes the second import request for Ayla's mailbox Ayla\MailboxImport1. - - - - -------------------------- Example 2 -------------------------- - 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 -------------------------- - Get-MailboxImportRequest -Status Completed | Remove-MailboxImportRequest - - This example removes all completed import requests. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mailboximportrequest - - - - - - Remove-MailboxRestoreRequest - Remove - MailboxRestoreRequest - - This cmdlet is available in 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-MailboxRestoreRequest cmdlet to remove fully or partially completed restore requests. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The parameter set that requires the Identity parameter allows you to remove a fully or partially completed restore request. - The parameter set that requires the RequestGuid and RequestQueue parameters is used for Microsoft Exchange Mailbox Replication service (MRS) debugging purposes only. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MailboxRestoreRequest - - 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 a default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 a default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MailboxRestoreRequest -Identity "Ayla\MailboxRestore1" - - This example removes the second restore request Ayla\MailboxRestore1. - - - - -------------------------- Example 2 -------------------------- - Get-MailboxRestoreRequest -Status Completed | Remove-MailboxRestoreRequest - - This example removes all restore requests that have the status of Completed. - - - - -------------------------- Example 3 -------------------------- - Remove-MailboxRestoreRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f - - This example cancels the restore request by using the RequestGuid parameter for a request stored on MBXDB01. The parameter set that requires the RequestGuid and RequestQueue parameters is used for MRS debugging purposes only. You should only use this parameter set if instructed by Microsoft Customer Service and Support. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mailboxrestorerequest - - - - - - Remove-MigrationBatch - Remove - MigrationBatch - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 need to remove the individual migration user requests with the command: `Remove-MigrationUser <Identity> -Force`. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MigrationBatch - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-migrationbatch - - - - - - Remove-MigrationEndpoint - Remove - MigrationEndpoint - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Use the Remove-MigrationEndpoint cmdlet to remove an existing migration endpoint. - For more information about migration endpoints, see Set-MigrationEndpoint (https://docs.microsoft.com/powershell/module/exchange/set-migrationendpoint) and [New-MigrationEndpoint](https://docs.microsoft.com/powershell/module/exchange/new-migrationendpoint). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MigrationEndpoint - - Identity - - The Identity parameter specifies the name of the migration endpoint you want to remove. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the migration endpoint you want to remove. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MigrationEndpoint -Identity CrossForestME01 - - This example removes the migration endpoint CrossForestME01. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-migrationendpoint - - - - - - Remove-MigrationUser - Remove - MigrationUser - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MigrationUser - - Identity - - The Identity parameter specifies the user that you want to remove from the migration batch. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the user that you want to remove from the migration batch. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MigrationUser -Identity TonySmith - - This example removes the migration user Tony Smith from a migration batch. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-migrationuser - - - - - - Remove-MoveRequest - Remove - MoveRequest - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In coexistence environments with Exchange 2010 and newer versions of Exchange, don't run a newer version of Remove-MoveRequest to clear completed mailbox move requests between Exchange 2010 databases as documented in Clear or Remove Move Requests (https://docs.microsoft.com/previous-versions/office/exchange-server-2010/dd351276(v=exchg.141)). Otherwise, you might delete the mailbox that you just moved. In coexistence environments, only use the Remove-MoveRequest cmdlet on Exchange 2010 servers to clear completed Exchange 2010 move requests. For mailbox moves from an Exchange 2010 database to an Exchange 2016 database, you can safely run Remove-MoveRequest on the Exchange 2016 server. - In Exchange 2010, you need to use the Remove-MoveRequest cmdlet on completed move requests to clear the InTransit flag from the mailbox. This step isn't required for mailbox moves in newer versions of Exchange where the Remove-MoveRequest is only used to cancel existing move requests. - The MoveRequestQueue and MailboxGuid parameters are for debugging purposes only. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MoveRequest - - 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. - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-moverequest - - - - - - Remove-PublicFolderMailboxMigrationRequest - Remove - PublicFolderMailboxMigrationRequest - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-PublicFolderMailboxMigrationRequest - - 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. - - PublicFolderMailboxMigrationRequestIdParameter - - PublicFolderMailboxMigrationRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Remove-PublicFolderMailboxMigrationRequest - - 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. - - Guid - - Guid - - - None - - - 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. - - DatabaseIdParameter - - DatabaseIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - PublicFolderMailboxMigrationRequestIdParameter - - PublicFolderMailboxMigrationRequestIdParameter - - - None - - - 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. - - Guid - - Guid - - - None - - - 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. - - DatabaseIdParameter - - DatabaseIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-PublicFolderMailboxMigrationRequest -Identity \PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e - - This example removes the specified public folder mailbox migration request. - - - - -------------------------- Example 2 -------------------------- - 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 -------------------------- - Get-PublicFolderMailboxMigrationRequest | group TargetMailbox | ?{$_.Count -gt 1} - - This example returns duplicate public folder migration requests (requests created for the same target mailbox). If the command returns no results, then there are no duplicate migration requests. - The sample script Remove Duplicate public folder MRS Requests (https://gallery.technet.microsoft.com/scriptcenter/Remove-Duplicate-public-055f0e5e)detects duplicate or orphaned public folder mailbox migration requests and also removes them. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-publicfoldermailboxmigrationrequest - - - - - - Remove-RecipientPermission - Remove - RecipientPermission - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When a user is given SendAs permission to another user or group, the user can send messages that appear to come from the other user or group. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-RecipientPermission - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - AccessRights - - The AccessRights parameter specifies the permission. - Valid input for this parameter is SendAs. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - RecipientIdParameter - - RecipientIdParameter - - - None - - - AccessRights - - The AccessRights parameter specifies the permission. - Valid input for this parameter is SendAs. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-recipientpermission - - - - - - Resume-MailboxImportRequest - Resume - MailboxImportRequest - - This cmdlet is available in 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://docs.microsoft.com/microsoft-365/compliance/use-network-upload-to-import-pst-files). - This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet can be pipelined with the Get-MailboxImportRequest cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Resume-MailboxImportRequest - - 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`. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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`. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/resume-mailboximportrequest - - - - - - Resume-MailboxRestoreRequest - Resume - MailboxRestoreRequest - - This cmdlet is available in 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-MailboxRestoreRequest cmdlet to resume a restore request that was suspended or failed. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Resume-MailboxRestoreRequest - - 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). - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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). - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Resume-MailboxRestoreRequest -Identity "kweku\RestoreFromDB01" - - This example resumes the restore request with the identity kweku\RestoreFromDB01. - - - - -------------------------- Example 2 -------------------------- - Get-MailboxRestoreRequest -Status Failed | Resume-MailboxRestoreRequest - - This example resumes any restore request with the status of Failed. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/resume-mailboxrestorerequest - - - - - - Resume-MoveRequest - Resume - MoveRequest - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Resume-MoveRequest - - 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 - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - SuspendWhenReadyToComplete - - The SuspendWhenReadyToComplete switch 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - SuspendWhenReadyToComplete - - The SuspendWhenReadyToComplete switch 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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." - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/resume-moverequest - - - - - - Set-MailboxImportRequest - Set - MailboxImportRequest - - This cmdlet is available in 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-MailboxImportRequest cmdlet to change import request options after the request has been created. You can use the Set-MailboxImportRequest cmdlet to recover from failed import requests. - This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can pipeline the Set-MailboxImportRequest cmdlet from the Get-MailboxImportRequest cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxImportRequest - - 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 specified a name for the import request with the New-MailboxImportRequest cmdlet, use the following syntax: `Alias\Name`. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies the name of the batch. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - SkipMerging - - The SkipMerging parameter specifies the steps in the import that should be skipped. This parameter is used primarily for debugging purposes. - - SkippableMergeComponent[] - - SkippableMergeComponent[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 specified a name for the import request with the New-MailboxImportRequest cmdlet, use the following syntax: `Alias\Name`. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies the name of the batch. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - SkipMerging - - The SkipMerging parameter specifies the steps in the import that should be skipped. This parameter is used primarily for debugging purposes. - - SkippableMergeComponent[] - - SkippableMergeComponent[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Get-MailboxImportRequest -Status Suspended | Set-MailboxImportRequest -BatchName April14 - - This example finds all import requests that have a status of Suspended, and then gives them a batch name of April14. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboximportrequest - - - - - - Set-MailboxPlan - Set - MailboxPlan - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxPlan - - 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 - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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://docs.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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - RetentionPolicy - - 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. The default value is Default MRM Policy. - Use the Get-RetentionPolicy cmdlet to see the available retention policies. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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://docs.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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - RetentionPolicy - - 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. The default value is Default MRM Policy. - Use the Get-RetentionPolicy cmdlet to see the available retention policies. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxplan - - - - - - Set-MailboxRestoreRequest - Set - MailboxRestoreRequest - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxRestoreRequest - - 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). - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - RemoteHostName - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMergeComponent[] - - SkippableMergeComponent[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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). - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - RemoteHostName - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMergeComponent[] - - SkippableMergeComponent[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxrestorerequest - - - - - - Set-MigrationBatch - Set - MigrationBatch - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see New-MigrationBatch (https://docs.microsoft.com/powershell/module/exchange/new-migrationbatch). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The 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 - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MigrationBatch - - 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) - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ApproveSkippedItems - - This parameter is available only in the cloud-based service. - The ApproveSkippedItems switch marks all of the skipped items discovered prior to the current time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. - For more information about maximum message size values, see the following topic Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). - You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ApproveSkippedItems - - This parameter is available only in the cloud-based service. - The ApproveSkippedItems switch marks all of the skipped items discovered prior to the current time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. - For more information about maximum message size values, see the following topic Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). - You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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. - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-migrationbatch - - - - - - Set-MigrationConfig - Set - MigrationConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MigrationConfig - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-migrationconfig - - - - - - Set-MigrationEndpoint - Set - MigrationEndpoint - - This cmdlet is available in 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, G Suite migrations, and remote moves. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 G Suite tenant to Exchange Online. For a G Suite migration, you must first create the cloud-based mail users or mailboxes before you migrate mailbox data. G Suite 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://docs.microsoft.com/Exchange/recipients/mailbox-moves)- Manage on-premises mailbox moves in Exchange Server (https://docs.microsoft.com/Exchange/architecture/mailbox-servers/manage-mailbox-moves)Changes made to an endpoint that affect the individual users within the batch are applied starting at the next time that the batch is processed. If you are running this cmdlet in the cloud-based service and wish to speed up the application of these settings, consider running the Set-MigrationBatch cmdlet with the -Update parameter. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MigrationEndpoint - - Identity - - The Identity parameter specifies the name of the migration endpoint you want to configure. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - Authentication - - This parameter is available only in the cloud-based service. - The Authentication parameter specifies the authentication method used by the remote mail server. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the username and password for connecting to the remote endpoint. Credentials should be used when creating either a staged or cutover Exchange endpoint or a RemoteMove endpoint. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - String - - String - - - None - - - 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. - - MigrationMailboxPermission - - MigrationMailboxPermission - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - PublicFolderDatabaseServerLegacyDN - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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 - - Fqdn - - Fqdn - - - None - - - 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. - - IMAPSecurityMechanism - - IMAPSecurityMechanism - - - None - - - 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. - Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes(path of the JSON file>))`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json")`) - - Byte[] - - Byte[] - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the migration endpoint you want to configure. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - Authentication - - This parameter is available only in the cloud-based service. - The Authentication parameter specifies the authentication method used by the remote mail server. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the username and password for connecting to the remote endpoint. Credentials should be used when creating either a staged or cutover Exchange endpoint or a RemoteMove endpoint. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - String - - String - - - None - - - 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. - - MigrationMailboxPermission - - MigrationMailboxPermission - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - PublicFolderDatabaseServerLegacyDN - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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 - - Fqdn - - Fqdn - - - None - - - 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. - - IMAPSecurityMechanism - - IMAPSecurityMechanism - - - None - - - 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. - Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes(path of the JSON file>))`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json")`) - - Byte[] - - Byte[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-migrationendpoint - - - - - - Set-MigrationUser - Set - MigrationUser - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Some settings can be applied both to the batch as well as to individual users within the batch. It is important to note that when a setting is applied to a user it will override any corresponding setting on the batch. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MigrationUser - - 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. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - ApproveSkippedItems - - This parameter is available only in the cloud-based service. - The ApproveSkippedItems switch marks all of the skipped items discovered prior to the current time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. - For more information about maximum message size values, see the following topic Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). - You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - StartAfter - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - ApproveSkippedItems - - This parameter is available only in the cloud-based service. - The ApproveSkippedItems switch marks all of the skipped items discovered prior to the current time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. - For more information about maximum message size values, see the following topic Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). - You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - CompleteAfter - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - Partition - - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - StartAfter - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 2 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-migrationuser - - - - - - Set-MoveRequest - Set - MoveRequest - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can pipeline the Set-MoveRequest cmdlet from the Get-MoveRequestStatistics, Get-MoveRequest, or Get-Mailbox cmdlets. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MoveRequest - - 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 - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies a different name for a batch. - - String - - String - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - RemoteCredential - - The RemoteCredential parameter specifies the username and password an administrator who has permission to perform the mailbox move. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - RemoteGlobalCatalog - - The RemoteGlobalCatalog parameter specifies the FQDN of the global catalog server for the remote forest. - - Fqdn - - Fqdn - - - None - - - RemoteHostName - - The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMoveComponent[] - - SkippableMoveComponent[] - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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://docs.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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - BatchName - - The BatchName parameter specifies a different name for a batch. - - String - - String - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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://docs.microsoft.com/Exchange/mail-flow/message-size-limits)- Exchange Online: Exchange Online Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits)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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - RemoteCredential - - The RemoteCredential parameter specifies the username and password an administrator who has permission to perform the mailbox move. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - RemoteGlobalCatalog - - The RemoteGlobalCatalog parameter specifies the FQDN of the global catalog server for the remote forest. - - Fqdn - - Fqdn - - - None - - - RemoteHostName - - The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SkippableMoveComponent[] - - SkippableMoveComponent[] - - - None - - - 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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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://docs.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, "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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 2 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-moverequest - - - - - - Start-MigrationBatch - Start - MigrationBatch - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Start-MigrationBatch - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Start-MigrationBatch -Identity SEM1 - - This example starts the migration batch SEM1. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/start-migrationbatch - - - - - - Start-MigrationUser - Start - MigrationUser - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Start-MigrationUser - - 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. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Start-MigrationUser -Identity laura@contoso.com - - This example starts the migration of the user named laura@contoso.com - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/start-migrationuser - - - - - - Stop-MigrationBatch - Stop - MigrationBatch - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Stop-MigrationBatch cmdlet stops the migration batch that's being processed in your on-premises Exchange organization or by the cloud-based migration service running in Microsoft 365. You can only stop migration batches that have mailboxes that are still in the process of being migrated or are waiting to be migrated. Stopping a migration won't affect mailboxes that have been migrated already. The migration of mailboxes that are being actively migrated is stopped immediately. If all migration requests in a migration batch are completed or failed, this cmdlet won't run. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Stop-MigrationBatch - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - MigrationBatchIdParameter - - MigrationBatchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/stop-migrationbatch - - - - - - Stop-MigrationUser - Stop - MigrationUser - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Stop-MigrationUser - - 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. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Partition - - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - MigrationUserIdParameter - - MigrationUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Partition - - This parameter is reserved for internal Microsoft use. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Stop-MigrationUser -Identity laura@contoso.com - - This example stops the migration of the user laura@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/stop-migrationuser - - - - - - Suspend-MailboxImportRequest - Suspend - MailboxImportRequest - - This cmdlet is available in 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://docs.microsoft.com/microsoft-365/compliance/use-network-upload-to-import-pst-files). - This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Suspend-MailboxImportRequest - - 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`. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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`. - - MailboxImportRequestIdParameter - - MailboxImportRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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.)". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/suspend-mailboximportrequest - - - - - - Suspend-MailboxRestoreRequest - Suspend - MailboxRestoreRequest - - This cmdlet is available in 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-MailboxRestoreRequest cmdlet to suspend a restore request any time after the request was created, but before the request reaches the status of Completed. You can resume the restore request by using the Resume-MailboxRestoreRequest cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Suspend-MailboxRestoreRequest - - 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). - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - SuspendComment - - The SuspendComment parameter specifies a description about why the request was suspended. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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). - - MailboxRestoreRequestIdParameter - - MailboxRestoreRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - SuspendComment - - The SuspendComment parameter specifies a description about why the request was suspended. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Suspend-MailboxRestoreRequest -Identity "Ayla\MailboxRestore1" - - This example suspends the second restore request for Ayla's mailbox with the identity Ayla\MailboxRestore1. - - - - -------------------------- Example 2 -------------------------- - Get-MailboxRestoreRequest -Status InProgress | Suspend-MailboxRestoreRequest -SuspendComment "Resume after 10:00 PM" - - This example suspends all restore requests that are in progress by using the Get-MailboxRestoreRequest cmdlet to retrieve all requests with a status of InProgress and then pipelines the output to the Suspend-MailboxRestoreRequest cmdlet with the suspend comment "Resume after 10:00 PM." - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/suspend-mailboxrestorerequest - - - - - - Suspend-MoveRequest - Suspend - MoveRequest - - This cmdlet is available in 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-MoveRequest cmdlet to suspend a move request any time after the move request was created, but before it reaches the status of CompletionInProgress. You can resume the move request by using the Resume-MoveRequest cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Suspend-MoveRequest - - 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) - - LegacyExchangeDN - - SMTP address - - Alias - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - SuspendComment - - The SuspendComment parameter specifies a description as to why the request was suspended. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - LegacyExchangeDN - - SMTP address - - Alias - - MoveRequestIdParameter - - MoveRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - SuspendComment - - The SuspendComment parameter specifies a description as to why the request was suspended. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Suspend-MoveRequest -Identity "Ayla@humongousinsurance.com" - - This example suspends the move request for Ayla's mailbox. - - - - -------------------------- Example 2 -------------------------- - Get-MoveRequest -MoveStatus InProgress | Suspend-MoveRequest - - This example suspends all move requests that are in progress by using the Get-MoveRequest cmdlet to retrieve all move requests with a MoveStatus value of InProgress and then pipelining the output to the Suspend-MoveRequest cmdlet. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/suspend-moverequest - - - - - - Suspend-PublicFolderMailboxMigrationRequest - Suspend - PublicFolderMailboxMigrationRequest - - This cmdlet is available in 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-PublicFolderMailboxMigrationRequest cmdlet to suspend individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Suspend-PublicFolderMailboxMigrationRequest - - 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`). - - PublicFolderMailboxMigrationRequestIdParameter - - PublicFolderMailboxMigrationRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - SuspendComment - - The SuspendComment parameter specifies a descriptive reason for why you suspended the public folder mailbox migration. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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`). - - PublicFolderMailboxMigrationRequestIdParameter - - PublicFolderMailboxMigrationRequestIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - SuspendComment - - The SuspendComment parameter specifies a descriptive reason for why you suspended the public folder mailbox migration. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Suspend-PublicFolderMailboxMigrationRequest -Identity \PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e - - This example suspends the specified public folder mailbox migration request. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/suspend-publicfoldermailboxmigrationrequest - - - - - - Test-MigrationServerAvailability - Test - MigrationServerAvailability - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-MigrationServerAvailability - - 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. - - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - Compliance - - The Compliance switch specifies that the endpoint type is compliance. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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 - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MigrationMailboxPermission - - MigrationMailboxPermission - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - PSTImport - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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 - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - FilePath - - The FilePath parameter specifies the path containing the PST files when testing a PST Import migration endpoint. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MigrationMailboxPermission - - MigrationMailboxPermission - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - PublicFolder - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - PublicFolderDatabaseServerLegacyDN - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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 - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - PublicFolderDatabaseServerLegacyDN - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - PublicFolder - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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 - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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 - - Fqdn - - Fqdn - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - Gmail - - This parameter is available only in the cloud-based service. - The Gmail parameter specifies Gmail migration as the migration type. This parameter is required when you want to migrate data from a G Suite tenant to Exchange Online mailboxes. - - - SwitchParameter - - - 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. - Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes(<path of the JSON file>))`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json"))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - 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. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Test-MigrationServerAvailability - - 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. - - - SwitchParameter - - - 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). - - Int32 - - Int32 - - - None - - - 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 - - Fqdn - - Fqdn - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - IMAPSecurityMechanism - - IMAPSecurityMechanism - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Compliance - - The Compliance switch specifies that the endpoint type is compliance. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Credentials - - The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MigrationEndpointIdParameter - - MigrationEndpointIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Gmail - - This parameter is available only in the cloud-based service. - The Gmail parameter specifies Gmail migration as the migration type. This parameter is required when you want to migrate data from a G Suite tenant to Exchange Online mailboxes. - - SwitchParameter - - SwitchParameter - - - 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). - - Int32 - - Int32 - - - None - - - PSTImport - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - PublicFolder - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - PublicFolderDatabaseServerLegacyDN - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - Fqdn - - Fqdn - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - 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. - Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes(<path of the JSON file>))`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json"))`. - - Byte[] - - Byte[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - AuthenticationMethod - - AuthenticationMethod - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - FilePath - - The FilePath parameter specifies the path containing the PST files when testing a PST Import migration endpoint. - - String - - String - - - None - - - 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. - - MigrationMailboxPermission - - MigrationMailboxPermission - - - None - - - 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. - - IMAPSecurityMechanism - - IMAPSecurityMechanism - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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).Identity -Foreach ($MEP in $MRSEndpoints) {Test-MigrationServerAvailability -Endpoint $MEP} - - This example tests multiple existing endpoints. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-migrationserveravailability - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.RecordsandEdge-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.RecordsandEdge-Help.xml deleted file mode 100644 index 7a9d5358d5f8..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.RecordsandEdge-Help.xml +++ /dev/null @@ -1,17137 +0,0 @@ - - - - - Add-ComplianceCaseMember - Add - ComplianceCaseMember - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Add-ComplianceCaseMember - - 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. - - String - - String - - - None - - - 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 - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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 - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Add-ComplianceCaseMember -Case "Case 2112" -Member johnevans@contoso.com - - This example adds John Evans to the eDiscovery case named Case 2112. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-compliancecasemember - - - - - - Add-eDiscoveryCaseAdmin - Add - eDiscoveryCaseAdmin - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Add-eDiscoveryCaseAdmin - - 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 - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Add-eDiscoveryCaseAdmin -User michelle@contoso.com - - This example adds an eDiscovery Administrator. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-ediscoverycaseadmin - - - - - - Get-AdminAuditLogConfig - Get - AdminAuditLogConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AdminAuditLogConfig - - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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: - - About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines)- Working with command output (https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help) - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-adminauditlogconfig - - - - - - Get-AuditLogSearch - Get - AuditLogSearch - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Run the Get-AuditLogSearch cmdlet to return a list of pending audit log searches. If an audit log search has been completed, it won't be displayed in the list of audit log searches. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AuditLogSearch - - 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. - - AuditLogSearchIdParameter - - AuditLogSearchIdParameter - - - None - - - 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". - - ExDateTime - - ExDateTime - - - None - - - 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". - - ExDateTime - - ExDateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - - - - 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. - - AuditLogSearchIdParameter - - AuditLogSearchIdParameter - - - None - - - 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". - - ExDateTime - - ExDateTime - - - None - - - 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". - - ExDateTime - - ExDateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-auditlogsearch - - - - - - Get-ComplianceCase - Get - ComplianceCase - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-ComplianceCase cmdlet to different types of compliance cases in the Security & Compliance Center and Microsoft 365 compliance center. 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ComplianceCase - - 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) - - ComplianceCaseIdParameter - - ComplianceCaseIdParameter - - - None - - - CaseType - - The CaseType parameter specifies the type of compliance case that you want to view. Valid values are: - - AdvancedEdiscovery: Advanced eDiscovery cases are used to manage legal or other types of investigations. In the Security & Compliance Center, Advanced eDiscovery cases are displayed under eDiscovery > Advanced eDiscovery . - ComplianceClassifier: This type of case corresponds to a trainable classifier. In the Microsoft 365 compliance center, 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 Security & Compliance Center, 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 Security & Compliance Center, DSR cases are displayed under Data privacy > Data subject requests . - eDiscovery: eDiscovery (also called core eDiscovery) cases are used to manage legal or other types of investigations. In the Security & Compliance Center, core eDiscovery cases are displayed under eDiscovery > eDiscovery . This is the default value. - InsiderRisk: Insider risk cases are use to manage insider risk management cases. In the Microsoft 365 compliance center, insider risk cases are displayed under Insider risk management > Cases . Typically, insider risk management cases are manually created in the compliance center to further investigate activity based on an risk alert. - InternalInvestigation: This value is reserved for internal Microsoft use. - - SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft 365 Compliance center, communication compliance policies are displayed under Communication compliance > Policies . - - ComplianceCaseType - - ComplianceCaseType - - - eDiscovery - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - RecentOnly - - The RecentOnly switch returns a list of the most recently modified cases of the specified case type. This switch is used to display data in the "Recently cases" widget that's displayed in the compliance centers for some of the features that use compliance case objects. - - - SwitchParameter - - - 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 core eDiscovery cases that the role group is a member of. - - String - - String - - - None - - - - - - 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) - - ComplianceCaseIdParameter - - ComplianceCaseIdParameter - - - None - - - CaseType - - The CaseType parameter specifies the type of compliance case that you want to view. Valid values are: - - AdvancedEdiscovery: Advanced eDiscovery cases are used to manage legal or other types of investigations. In the Security & Compliance Center, Advanced eDiscovery cases are displayed under eDiscovery > Advanced eDiscovery . - ComplianceClassifier: This type of case corresponds to a trainable classifier. In the Microsoft 365 compliance center, 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 Security & Compliance Center, 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 Security & Compliance Center, DSR cases are displayed under Data privacy > Data subject requests . - eDiscovery: eDiscovery (also called core eDiscovery) cases are used to manage legal or other types of investigations. In the Security & Compliance Center, core eDiscovery cases are displayed under eDiscovery > eDiscovery . This is the default value. - InsiderRisk: Insider risk cases are use to manage insider risk management cases. In the Microsoft 365 compliance center, insider risk cases are displayed under Insider risk management > Cases . Typically, insider risk management cases are manually created in the compliance center to further investigate activity based on an risk alert. - InternalInvestigation: This value is reserved for internal Microsoft use. - - SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft 365 Compliance center, communication compliance policies are displayed under Communication compliance > Policies . - - ComplianceCaseType - - ComplianceCaseType - - - eDiscovery - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - RecentOnly - - The RecentOnly switch returns a list of the most recently modified cases of the specified case type. This switch is used to display data in the "Recently cases" widget that's displayed in the compliance centers for some of the features that use compliance case objects. - - SwitchParameter - - SwitchParameter - - - 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 core eDiscovery cases that the role group is a member of. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ComplianceCase - - This example returns a summary list of all core eDiscovery cases in the organization. - - - - -------------------------- Example 2 -------------------------- - Get-ComplianceCase -Identity "Contoso Legal" | Format-List - - This example returns detailed information for the core eDiscovery case named Contoso Legal. - - - - -------------------------- Example 3 -------------------------- - Get-ComplianceCase -CaseType AdvancedEdiscovery - - This example returns a summary list of all Advanced eDiscovery cases in the organization. - - - - -------------------------- Example 4 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-compliancecase - - - - - - Get-ComplianceCaseMember - Get - ComplianceCaseMember - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ComplianceCaseMember - - 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 ("). - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ComplianceCaseMember -Case "Fabrikam Litigation" - - This examples shows the members of the eDiscovery case named Fabrikam Litigation. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-compliancecasemember - - - - - - Get-ComplianceSearch - Get - ComplianceSearch - - This cmdlet is available in 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 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.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 and not to the Organization Management role group. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ComplianceSearch - - 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. - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - Case - - This parameter is available only in the cloud-based service. - The Case parameter filters the results by the name of a Core eDiscovery 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 Advanced eDiscovery cases. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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. - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - Case - - This parameter is available only in the cloud-based service. - The Case parameter filters the results by the name of a Core eDiscovery 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 Advanced eDiscovery cases. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-compliancesearch - - - - - - Get-ComplianceSearchAction - Get - ComplianceSearchAction - - This cmdlet is available in 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 Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - After you create and run a compliance search using the New-ComplianceSearch cmdlet, and start the search using the Start-ComplianceSearch cmdlet, you assign a search action using the New-ComplianceSearchAction cmdlet. You use the Get-ComplianceSearchAction cmdlet to track the progress of the compliance search action. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ComplianceSearchAction - - 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) - - ComplianceSearchActionIdParameter - - ComplianceSearchActionIdParameter - - - None - - - Case - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Details - - The Details switch specifies whether to include detailed information in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-ComplianceSearchAction - - Case - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Details - - The Details switch specifies whether to include detailed information in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Export - - The Export switch filters the results by Export compliance search actions. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-ComplianceSearchAction - - Case - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Details - - The Details switch specifies whether to include detailed information in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Preview - - The Preview switch filters the results by Preview compliance search actions. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-ComplianceSearchAction - - Case - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Details - - The Details switch specifies whether to include detailed information in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Purge - - The Purge switch filters the results by Purge compliance search actions. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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) - - ComplianceSearchActionIdParameter - - ComplianceSearchActionIdParameter - - - None - - - Case - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Details - - The Details switch specifies whether to include detailed information in the results. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Export - - The Export switch filters the results by Export compliance search actions. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Preview - - The Preview switch filters the results by Preview compliance search actions. - - SwitchParameter - - SwitchParameter - - - False - - - Purge - - The Purge switch filters the results by Purge compliance search actions. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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" - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-compliancesearchaction - - - - - - Get-ComplianceSecurityFilter - Get - ComplianceSecurityFilter - - This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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 Microsoft 365 organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ComplianceSecurityFilter - - 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 - - ComplianceSecurityFilterActionType - - ComplianceSecurityFilterActionType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceSecurityFilterActionType - - ComplianceSecurityFilterActionType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-compliancesecurityfilter - - - - - - Get-eDiscoveryCaseAdmin - Get - eDiscoveryCaseAdmin - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-eDiscoveryCaseAdmin - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-eDiscoveryCaseAdmin - - This example returns a summary list of all eDiscovery Administrators. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-ediscoverycaseadmin - - - - - - Get-MailboxAuditBypassAssociation - Get - MailboxAuditBypassAssociation - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only). You use the Set-MailboxAuditBypassAssociation (https://docs.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation)cmdlet to enable this property to bypass mailbox audit logging. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxAuditBypassAssociation - - Identity - - The Identity parameter specifies the user account or computer account where you want to view the value of the AuditBypassEnabled property. - - MailboxAuditBypassAssociationIdParameter - - MailboxAuditBypassAssociationIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - Identity - - The Identity parameter specifies the user account or computer account where you want to view the value of the AuditBypassEnabled property. - - MailboxAuditBypassAssociationIdParameter - - MailboxAuditBypassAssociationIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Get-MailboxAuditBypassAssociation -Identity "Svc-MyApplication" - - This example returns the status of the AuditBypassEnabled property for the Svc-MyApplication account. - - - - -------------------------- Example 3 -------------------------- - $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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxauditbypassassociation - - - - - - Get-MailboxFolderStatistics - Get - MailboxFolderStatistics - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.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. - - - - Get-MailboxFolderStatistics - - 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) - - GeneralMailboxOrMailUserIdParameter - - GeneralMailboxOrMailUserIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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 - - Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcFolderType - - Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcFolderType - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - - - 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) - - GeneralMailboxOrMailUserIdParameter - - GeneralMailboxOrMailUserIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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 - - Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcFolderType - - Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcFolderType - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 Archive switch to view the statistics for Ayla's archive. - - - - -------------------------- Example 4 -------------------------- - Get-MailboxFolderStatistics -Identity "Tony" -FolderScope RecoverableItems -IncludeAnalysis - - This example uses the IncludeAnalysis switch to view the statistics of Tony's Recoverable Items folder. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolderstatistics - - - - - - Get-MailboxSearch - Get - MailboxSearch - - This cmdlet is available in 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 Center PowerShell instead. For more information, see Retirement of legacy eDiscovery tools (https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In on-premises Exchange, a mailbox search is used to perform an In-Place eDiscovery or to place users on an In-Place Hold. Use the Get-MailboxSearch cmdlet to retrieve details of either type of mailbox search. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxSearch - - 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. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - ShowDeletionInProgressSearches - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - Get-MailboxSearch - - 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. - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - ShowDeletionInProgressSearches - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - ShowDeletionInProgressSearches - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 About Parameters (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxsearch - - - - - - Get-RecoverableItems - Get - RecoverableItems - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RecoverableItems - - 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"`. - - GeneralMailboxOrMailUserIdParameter[] - - GeneralMailboxOrMailUserIdParameter[] - - - None - - - 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.). - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - LastParentFolderID - - The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 will search all of these folders. - - - DeletedItems | RecoverableItems | PurgedItems - - RecoverableItemsFolderType - - RecoverableItemsFolderType - - - None - - - 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 ("). - - String - - String - - - None - - - - - - 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"`. - - GeneralMailboxOrMailUserIdParameter[] - - GeneralMailboxOrMailUserIdParameter[] - - - None - - - 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.). - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - LastParentFolderID - - The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 will search all of these folders. - - RecoverableItemsFolderType - - RecoverableItemsFolderType - - - None - - - 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 ("). - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Get-RecoverableItems - - - - - - Get-RetentionPolicy - Get - RetentionPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A retention policy is associated with a group of retention policy tags that specify retention settings for items in a mailbox. A policy may contain one default policy tag to move items to an archive mailbox, one default policy tag to delete all items, one default policy tag to delete voicemail items and multiple personal tags to move or delete items. A mailbox can have only one retention policy applied to it. The Get-RetentionPolicy cmdlet displays all policy settings associated with the specified policy. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RetentionPolicy - - Identity - - The Identity parameter specifies the policy name. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the policy name. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-retentionpolicy - - - - - - Get-RetentionPolicyTag - Get - RetentionPolicyTag - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RetentionPolicyTag - - Identity - - The Identity parameter specifies the name of the tag. - - RetentionPolicyTagIdParameter - - RetentionPolicyTagIdParameter - - - None - - - IncludeSystemTags - - The IncludeSystemTags switch specifies whether to return any system tags. - - - SwitchParameter - - - 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. - - ElcFolderType[] - - ElcFolderType[] - - - None - - - - Get-RetentionPolicyTag - - IncludeSystemTags - - The IncludeSystemTags switch specifies whether to return any system tags. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - ElcFolderType[] - - ElcFolderType[] - - - None - - - - - - Identity - - The Identity parameter specifies the name of the tag. - - RetentionPolicyTagIdParameter - - RetentionPolicyTagIdParameter - - - None - - - IncludeSystemTags - - The IncludeSystemTags switch specifies whether to return any system tags. - - SwitchParameter - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - ElcFolderType[] - - ElcFolderType[] - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-retentionpolicytag - - - - - - Invoke-ComplianceSearchActionStep - Invoke - ComplianceSearchActionStep - - This cmdlet is available in on-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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet is reserved for internal Microsoft use. - - - - Invoke-ComplianceSearchActionStep - - Identity - - This cmdlet is reserved for internal Microsoft use. - - ComplianceSearchActionIdParameter - - ComplianceSearchActionIdParameter - - - None - - - Parameters - - This cmdlet is reserved for internal Microsoft use. - - PSObject - - PSObject - - - None - - - Step - - This cmdlet is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - - - - Identity - - This cmdlet is reserved for internal Microsoft use. - - ComplianceSearchActionIdParameter - - ComplianceSearchActionIdParameter - - - None - - - Parameters - - This cmdlet is reserved for internal Microsoft use. - - PSObject - - PSObject - - - None - - - Step - - This cmdlet is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Invoke-ComplianceSearchActionStep - - This cmdlet is reserved for internal Microsoft use. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/invoke-compliancesearchactionstep - - - - - - New-AdminAuditLogSearch - New - AdminAuditLogSearch - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the New-AdminAuditLogSearch cmdlet to search the contents of the administrator audit log and send the results to one or more mailboxes that you specify. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - After the New-AdminAuditLogSearch cmdlet is run, the report is delivered to the mailboxes you specify within 15 minutes. The log is included as an XML attachment on the report email message. The maximum size of the log that can be generated is 10 megabytes (MB). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-AdminAuditLogSearch - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - StatusMailRecipients - - The StatusMailRecipients parameter specifies the recipients that should receive the administrator audit log report. The recipient must be a valid SMTP address. - If you want to specify more than one recipient, separate each SMTP address with a comma. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the name of the administrator audit log search. The name is shown in the subject line of the audit log report email message. - If the name of the report contains spaces, enclose the name in quotation marks ("). - - String - - String - - - None - - - 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 mailboxes, aliases, Send connector names and so on. - If you want to specify more than one object ID, separate each ID with a comma. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - 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". - - ExDateTime - - ExDateTime - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - StatusMailRecipients - - The StatusMailRecipients parameter specifies the recipients that should receive the administrator audit log report. The recipient must be a valid SMTP address. - If you want to specify more than one recipient, separate each SMTP address with a comma. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the name of the administrator audit log search. The name is shown in the subject line of the audit log report email message. - If the name of the report contains spaces, enclose the name in quotation marks ("). - - String - - String - - - None - - - 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 mailboxes, aliases, Send connector names and so on. - If you want to specify more than one object ID, separate each ID with a comma. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - New-AdminAuditLogSearch -ExternalAccess $true -StartDate 07/25/2018 -EndDate 10/24/2018 -StatusMailRecipients admin@contoso.com,pilarp@contoso.com -Name "Datacenter admin audit log" - - This example returns entries in the administrator audit log of an Exchange Online organization for cmdlets run by Microsoft datacenter administrators between September 25, 2018 and October 24, 2018. The search results are sent to the admin@contoso.com and pilarp@contoso.com SMTP addresses and the text "Datacenter admin audit log" is added to the subject line of the message. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-adminauditlogsearch - - - - - - New-ComplianceCase - New - ComplianceCase - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-ComplianceCase - - 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 ("). - - String - - String - - - None - - - CaseType - - The CaseType parameter specifies the type of compliance case that you want to create. Valid values are: - - AdvancedEdiscovery: Advanced eDiscovery cases are used to manage legal or other types of investigations. In the Security & Compliance Center, Advanced eDiscovery cases are displayed under eDiscovery > Advanced eDiscovery. - - ComplianceClassifier: This type of case corresponds to a trainable classifier. In the Microsoft 365 compliance center, 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 Security & Compliance Center, 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 Security & Compliance Center, DSR cases are displayed under Data privacy > Data subject requests. - - eDiscovery: eDiscovery (also called core eDiscovery) cases are used to manage legal or other types of investigations. In the Security & Compliance Center, core eDiscovery cases are displayed under eDiscovery > eDiscovery. This is the default value. - - InsiderRisk: Insider risk cases are use to manage insider risk management cases. In the Microsoft 365 compliance center, insider risk cases are displayed under Insider risk management > Cases. Typically, insider risk management cases are manually created in the compliance center to further investigate activity based on an risk alert. - - InternalInvestigation: This value is reserved for internal Microsoft use. - - SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft 365 compliance center, communication compliance policies are displayed under Communication compliance > Policies. - - ComplianceCaseType - - ComplianceCaseType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - ExternalId - - The ExternalId parameter specifies an optional ID or external case number that you can associate with the new compliance case. - - String - - String - - - None - - - SecondaryCaseType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - SourceCaseType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - CaseType - - The CaseType parameter specifies the type of compliance case that you want to create. Valid values are: - - AdvancedEdiscovery: Advanced eDiscovery cases are used to manage legal or other types of investigations. In the Security & Compliance Center, Advanced eDiscovery cases are displayed under eDiscovery > Advanced eDiscovery. - - ComplianceClassifier: This type of case corresponds to a trainable classifier. In the Microsoft 365 compliance center, 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 Security & Compliance Center, 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 Security & Compliance Center, DSR cases are displayed under Data privacy > Data subject requests. - - eDiscovery: eDiscovery (also called core eDiscovery) cases are used to manage legal or other types of investigations. In the Security & Compliance Center, core eDiscovery cases are displayed under eDiscovery > eDiscovery. This is the default value. - - InsiderRisk: Insider risk cases are use to manage insider risk management cases. In the Microsoft 365 compliance center, insider risk cases are displayed under Insider risk management > Cases. Typically, insider risk management cases are manually created in the compliance center to further investigate activity based on an risk alert. - - InternalInvestigation: This value is reserved for internal Microsoft use. - - SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft 365 compliance center, communication compliance policies are displayed under Communication compliance > Policies. - - ComplianceCaseType - - ComplianceCaseType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - ExternalId - - The ExternalId parameter specifies an optional ID or external case number that you can associate with the new compliance case. - - String - - String - - - None - - - SecondaryCaseType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - SourceCaseType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-ComplianceCase -Name "Fabrikam Litigation" - - This example creates a new core eDiscovery case named Fabrikam Litigation. - - - - -------------------------- Example 2 -------------------------- - New-ComplianceCase -Name "Coho Case 03082020" -CaseType AdvancedEdiscovery -ExternalId "SaraDavis v. Coho Winery" - - This example creates a new Advanced eDiscovery case named Coho Case 03082020 and specifies an optional case Id of "SaraDavis v. Coho Winery". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-compliancecase - - - - - - New-ComplianceSearch - New - ComplianceSearch - - This cmdlet is available in 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 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.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, and not to the Organization Management role group. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-ComplianceSearch - - 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. - - String - - String - - - None - - - 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 - - Boolean - - Boolean - - - None - - - Case - - This parameter is available only in the cloud-based service. - The Case parameter specifies the name of a Core eDiscovery 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 Advanced eDiscovery cases. - If the Name parameter contains spaces, the value of the ExchangeLocation parameter is cleared when you use the Case parameter. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - Description - - The Description parameter specifies an optional description for the compliance search. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - 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, use the email address. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - - SwitchParameter - - - 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. - - String[] - - String[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Language - - The Language parameter specifies the language for the compliance search. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - LogLevel - - This parameter is reserved for internal Microsoft use. - - ComplianceJobLogLevel - - ComplianceJobLogLevel - - - None - - - 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. - - String[] - - String[] - - - None - - - PublicFolderLocationExclusion - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - RefinerNames - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - SharePointLocation - - This parameter is available only in the cloud-based service. - The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - SharePointLocationExclusion - - This parameter is available only in the cloud-based service. - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - StatusMailRecipients - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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 - - Boolean - - Boolean - - - None - - - Case - - This parameter is available only in the cloud-based service. - The Case parameter specifies the name of a Core eDiscovery 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 Advanced eDiscovery cases. - If the Name parameter contains spaces, the value of the ExchangeLocation parameter is cleared when you use the Case parameter. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - Description - - The Description parameter specifies an optional description for the compliance search. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - 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, use the email address. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String[] - - String[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Language - - The Language parameter specifies the language for the compliance search. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - LogLevel - - This parameter is reserved for internal Microsoft use. - - ComplianceJobLogLevel - - ComplianceJobLogLevel - - - None - - - 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. - - String[] - - String[] - - - None - - - PublicFolderLocationExclusion - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - RefinerNames - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - SharePointLocation - - This parameter is available only in the cloud-based service. - The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - SharePointLocationExclusion - - This parameter is available only in the cloud-based service. - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - StatusMailRecipients - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-compliancesearch - - - - - - New-ComplianceSearchAction - New - ComplianceSearchAction - - This cmdlet is available in 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 Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.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. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-ComplianceSearchAction - - 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. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - ComplianceExportArchiveFormat - - ComplianceExportArchiveFormat - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - ExchangeArchiveFormat - - This parameter is available or functional 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. - - 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. 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. - - ComplianceExportArchiveFormat - - ComplianceExportArchiveFormat - - - None - - - Export - - This parameter is available or functional 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. - - - SwitchParameter - - - False - - - FileTypeExclusionsForUnindexedItems - - The FileTypeExclusionsForUnindexedItems specifies the file types to exclude because they can't be indexed. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - - SwitchParameter - - - 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. - - Msg: Export to .msg message files. - - ComplianceDataTransferFormat - - ComplianceDataTransferFormat - - - None - - - IncludeCredential - - The IncludeCredential switch specifies whether to include the credential in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - JobOptions - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - ReferenceActionName - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Region - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Report - - This parameter is available or 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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 Microsoft 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: - - ComplianceSearchActionScenario - - ComplianceSearchActionScenario - - - None - - - 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. - - ComplianceExportScope - - ComplianceExportScope - - - None - - - 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. - - ComplianceScopeDetail[] - - ComplianceScopeDetail[] - - - None - - - 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. - - String[] - - String[] - - - None - - - SharePointArchiveFormat - - This parameter is available or functional 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 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. - - ComplianceExportArchiveFormat - - ComplianceExportArchiveFormat - - - None - - - Version - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - New-ComplianceSearchAction - - 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. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Msg: Export to .msg message files. - - ComplianceDataTransferFormat - - ComplianceDataTransferFormat - - - None - - - IncludeCredential - - The IncludeCredential switch specifies whether to include the credential in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - JobOptions - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - - SwitchParameter - - - False - - - ReferenceActionName - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Region - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 Microsoft 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: - - ComplianceSearchActionScenario - - ComplianceSearchActionScenario - - - None - - - 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. - - String[] - - String[] - - - None - - - Version - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - New-ComplianceSearchAction - - 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. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Msg: Export to .msg message files. - - ComplianceDataTransferFormat - - ComplianceDataTransferFormat - - - None - - - IncludeCredential - - The IncludeCredential switch specifies whether to include the credential in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - JobOptions - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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 Microsoft 365 organization (https://docs.microsoft.com/microsoft-365/compliance/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. - - - SwitchParameter - - - False - - - PurgeType - - 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. - - ComplianceDestroyType - - ComplianceDestroyType - - - None - - - ReferenceActionName - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Region - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 Microsoft 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: - - ComplianceSearchActionScenario - - ComplianceSearchActionScenario - - - None - - - 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. - - String[] - - String[] - - - None - - - Version - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - 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. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - ComplianceExportArchiveFormat - - ComplianceExportArchiveFormat - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - ExchangeArchiveFormat - - This parameter is available or functional 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. - - 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. 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. - - ComplianceExportArchiveFormat - - ComplianceExportArchiveFormat - - - None - - - Export - - This parameter is available or functional 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. - - SwitchParameter - - SwitchParameter - - - False - - - FileTypeExclusionsForUnindexedItems - - The FileTypeExclusionsForUnindexedItems specifies the file types to exclude because they can't be indexed. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Msg: Export to .msg message files. - - ComplianceDataTransferFormat - - ComplianceDataTransferFormat - - - None - - - IncludeCredential - - The IncludeCredential switch specifies whether to include the credential in the results. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - JobOptions - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 Microsoft 365 organization (https://docs.microsoft.com/microsoft-365/compliance/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. - - SwitchParameter - - SwitchParameter - - - False - - - PurgeType - - 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. - - ComplianceDestroyType - - ComplianceDestroyType - - - None - - - ReferenceActionName - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Region - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Report - - This parameter is available or 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 Microsoft 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: - - ComplianceSearchActionScenario - - ComplianceSearchActionScenario - - - None - - - 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. - - ComplianceExportScope - - ComplianceExportScope - - - None - - - 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. - - ComplianceScopeDetail[] - - ComplianceScopeDetail[] - - - None - - - 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. - - String[] - - String[] - - - None - - - SharePointArchiveFormat - - This parameter is available or functional 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 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. - - ComplianceExportArchiveFormat - - ComplianceExportArchiveFormat - - - None - - - Version - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-compliancesearchaction - - - - - - New-ComplianceSecurityFilter - New - ComplianceSecurityFilter - - This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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 Microsoft 365 organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-ComplianceSecurityFilter - - 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 Microsoft 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. - - ComplianceSecurityFilterActionType - - ComplianceSecurityFilterActionType - - - None - - - FilterName - - The FilterName parameter specifies the name for the compliance security filter. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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_<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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - 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://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). - 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 Server (https://docs.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. - You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. - You have to create a search permissions filter to explicitly prevent users from searching any content location in a specific Microsoft 365 service (such as preventing a user from searching Exchange mailboxes or SharePoint sites). In other words, creating a search permissions filter that allows a user to search all SharePoint sites in the organization doesn't prevent that user from searching mailboxes. For example, to allow a SharePoint admin to only search SharePoint sites, you have to create a 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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 Microsoft 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. - - ComplianceSecurityFilterActionType - - ComplianceSecurityFilterActionType - - - None - - - FilterName - - The FilterName parameter specifies the name for the compliance security filter. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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_<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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - 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://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). - 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 Server (https://docs.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. - You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. - You have to create a search permissions filter to explicitly prevent users from searching any content location in a specific Microsoft 365 service (such as preventing a user from searching Exchange mailboxes or SharePoint sites). In other words, creating a search permissions filter that allows a user to search all SharePoint sites in the organization doesn't prevent that user from searching mailboxes. For example, to allow a SharePoint admin to only search SharePoint sites, you have to create a 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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://docs.microsoft.com/microsoft-365/compliance/permissions-filtering-for-content-search). - - - - -------------------------- 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://docs.microsoft.com/microsoft-365/compliance/permissions-filtering-for-content-search). - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-compliancesecurityfilter - - - - - - New-MailboxAuditLogSearch - New - MailboxAuditLogSearch - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the New-MailboxAuditLogSearch cmdlet to search mailbox audit logs and have search results sent via email to specified recipients. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The New-MailboxAuditLogSearch cmdlet performs an asynchronous search of mailbox audit logs for the specified mailboxes and sends the search results by email to the specified recipients. The body of the email message contains search metadata such as search parameters and the time when the search request was submitted. The results are attached in an .xml file. - To search mailbox audit logs for a single mailbox and have the results displayed in the Exchange Management Shell window, use the Search-MailboxAuditLog cmdlet instead. To learn more about mailbox audit logging, see Mailbox audit logging in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/mailbox-audit-logging/mailbox-audit-logging). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MailboxAuditLogSearch - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - StatusMailRecipients - - The StatusMailRecipients parameter specifies the email address where the search results are sent. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ShowDetails - - The ShowDetails switch specifies that details of each log entry are retrieved. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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". - - ExDateTime - - ExDateTime - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - StatusMailRecipients - - The StatusMailRecipients parameter specifies the email address where the search results are sent. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ShowDetails - - The ShowDetails switch specifies that details of each log entry are retrieved. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mailboxauditlogsearch - - - - - - New-MailboxSearch - New - MailboxSearch - - This cmdlet is available in 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 Center PowerShell instead. For more information, see Retirement of legacy eDiscovery tools (https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/holds/holds). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MailboxSearch - - 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. - - String - - String - - - None - - - 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]). - - Boolean - - Boolean - - - None - - - 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]). - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - InPlaceHoldIdentity - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Language - - The Language parameter specifies a locale for the search. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - LoggingLevel - - LoggingLevel - - - None - - - 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. - - KindKeyword[] - - KindKeyword[] - - - None - - - 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. - - String[] - - String[] - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - 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 - - String - - String - - - None - - - 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 ("). - - String[] - - String[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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]). - - Boolean - - Boolean - - - None - - - 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]). - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - InPlaceHoldIdentity - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Language - - The Language parameter specifies a locale for the search. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - LoggingLevel - - LoggingLevel - - - None - - - 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. - - KindKeyword[] - - KindKeyword[] - - - None - - - 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. - - String[] - - String[] - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - 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 - - String - - String - - - None - - - 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 ("). - - String[] - - String[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - StatusMailRecipients: 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mailboxsearch - - - - - - New-RetentionPolicy - New - RetentionPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Retention policy tags are associated with a retention policy. When a retention policy is applied to a mailbox, tags associated with the policy are available to the mailbox user. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-RetentionPolicy - - Name - - The Name parameter specifies the policy name. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - IsDefault - - This parameter is available only in the cloud-based service. - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Guid - - Guid - - - None - - - RetentionPolicyTagLinks - - The RetentionPolicyTagLinks parameter specifies the names of retention policy tags to be associated with this policy. - - RetentionPolicyTagIdParameter[] - - RetentionPolicyTagIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the policy name. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - IsDefault - - This parameter is available only in the cloud-based service. - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Guid - - Guid - - - None - - - RetentionPolicyTagLinks - - The RetentionPolicyTagLinks parameter specifies the names of retention policy tags to be associated with this policy. - - RetentionPolicyTagIdParameter[] - - RetentionPolicyTagIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-retentionpolicy - - - - - - New-RetentionPolicyTag - New - RetentionPolicyTag - - This cmdlet is available in 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-RetentionPolicyTag cmdlet to create a retention tag. - For more information about retention tags, see Retention tags and retention policies in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Retention tags are used to apply message retention settings to folders and items in a mailbox. - Retention tags support a display of the tag name and an optional comment in localized languages. Language culture codes from the CultureInfo class are used for this purpose. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-RetentionPolicyTag - - Name - - The Name parameter specifies the name of the tag. - - String - - String - - - None - - - AgeLimitForRetention - - The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - Comment - - The Comment parameter specifies a comment for the tag. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - IsDefaultAutoGroupPolicyTag - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - IsDefaultModeratedRecipientsPolicyTag - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - LocalizedComment - - The LocalizedComment parameter specifies localized comments and their languages. When the user's language setting matches a language specified for this parameter, Microsoft Outlook and Outlook on the web display the corresponding localized comment. Comments are specified in the form of ISO Language Code:Comment, for example, LocalizedComment EN-US:"This is a localized comment in U.S. English". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - LocalizedRetentionPolicyTagName - - The LocalizedRetentionPolicyTagName parameter specifies localized tag names and their languages. When the user's language setting matches a language specified for this parameter, Outlook and Outlook on the web display the corresponding localized tag name. Names are specified in the form of ISO Language Code:Name, for example, LocalizedRetentionPolicyTagName EN-US:"Business Critical". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MessageClass - - The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to *. - With the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of * are supported, and they apply to all message types. - To create a DPT for voice mail messages, set the MessageClass parameter to voicemail and the Type parameter to All. - A DPT for voice mail messages applies only to Microsoft Exchange Unified Messaging voice mail messages (identified by the PR_MESSAGE_CLASS MAPI property value IPM.Note.Microsoft.Voicemail*). - - String - - String - - - None - - - MustDisplayCommentEnabled - - The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. - - Boolean - - Boolean - - - None - - - RetentionAction - - 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). - If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. - - RetentionAction - - RetentionAction - - - None - - - 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 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_<Original Name>`. - - Boolean - - Boolean - - - None - - - RetentionId - - The RetentionId parameter specifies an alternate tag ID to make sure the retention tag found on mailbox items tagged in an on-premises deployment matches the tag when the mailbox is moved to the cloud, or mailbox items tagged in the cloud match the tag when the mailbox is moved to an on-premises Exchange server. The parameter is used in cross-premises deployments. You don't need to specify this parameter in on-premises-only deployments. - - Guid - - Guid - - - None - - - SystemTag - - The SystemTag parameter specifies that the tag is created for internal Exchange functionality. - - Boolean - - Boolean - - - None - - - Type - - 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. - - ElcFolderType - - ElcFolderType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the name of the tag. - - String - - String - - - None - - - AgeLimitForRetention - - The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - Comment - - The Comment parameter specifies a comment for the tag. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - IsDefaultAutoGroupPolicyTag - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - IsDefaultModeratedRecipientsPolicyTag - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - LocalizedComment - - The LocalizedComment parameter specifies localized comments and their languages. When the user's language setting matches a language specified for this parameter, Microsoft Outlook and Outlook on the web display the corresponding localized comment. Comments are specified in the form of ISO Language Code:Comment, for example, LocalizedComment EN-US:"This is a localized comment in U.S. English". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - LocalizedRetentionPolicyTagName - - The LocalizedRetentionPolicyTagName parameter specifies localized tag names and their languages. When the user's language setting matches a language specified for this parameter, Outlook and Outlook on the web display the corresponding localized tag name. Names are specified in the form of ISO Language Code:Name, for example, LocalizedRetentionPolicyTagName EN-US:"Business Critical". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MessageClass - - The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to *. - With the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of * are supported, and they apply to all message types. - To create a DPT for voice mail messages, set the MessageClass parameter to voicemail and the Type parameter to All. - A DPT for voice mail messages applies only to Microsoft Exchange Unified Messaging voice mail messages (identified by the PR_MESSAGE_CLASS MAPI property value IPM.Note.Microsoft.Voicemail*). - - String - - String - - - None - - - MustDisplayCommentEnabled - - The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. - - Boolean - - Boolean - - - None - - - RetentionAction - - 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). - If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. - - RetentionAction - - RetentionAction - - - None - - - 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 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_<Original Name>`. - - Boolean - - Boolean - - - None - - - RetentionId - - The RetentionId parameter specifies an alternate tag ID to make sure the retention tag found on mailbox items tagged in an on-premises deployment matches the tag when the mailbox is moved to the cloud, or mailbox items tagged in the cloud match the tag when the mailbox is moved to an on-premises Exchange server. The parameter is used in cross-premises deployments. You don't need to specify this parameter in on-premises-only deployments. - - Guid - - Guid - - - None - - - SystemTag - - The SystemTag parameter specifies that the tag is created for internal Exchange functionality. - - Boolean - - Boolean - - - None - - - Type - - 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. - - ElcFolderType - - ElcFolderType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - New-RetentionPolicyTag "Business Critical" -Type Personal -Comment "Use this tag for all business critical mail" -RetentionEnabled $true -AgeLimitForRetention 2556 -RetentionAction PermanentlyDelete - - This example creates the retention tag Business Critical of type Personal. When applied to mailbox items as part of a retention policy, the items are permanently deleted in approximately seven years. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-retentionpolicytag - - - - - - Remove-ComplianceCase - Remove - ComplianceCase - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-ComplianceCase cmdlet to remove compliance cases from the Security & Compliance Center or the Microsoft 365 compliance center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-ComplianceCase - - 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) - - ComplianceCaseIdParameter - - ComplianceCaseIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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) - - ComplianceCaseIdParameter - - ComplianceCaseIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ComplianceCase -Identity "Case 5150" - - This example removes the compliance case named Case 5150 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-compliancecase - - - - - - Remove-ComplianceCaseMember - Remove - ComplianceCaseMember - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-ComplianceCaseMember - - 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. - - String - - String - - - None - - - 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 - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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 - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ComplianceCaseMember -Case "Case OU812" -Member "Jan Dryml" - - This example removes Jan Dryml from the eDiscovery case named Case OU812. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-compliancecasemember - - - - - - Remove-ComplianceSearch - Remove - ComplianceSearch - - This cmdlet is available in 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 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.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 and not to the Organization Management role group. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-ComplianceSearch - - 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 - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ComplianceSearch -Identity "Case 1234" - - This example removes the compliance search named Case 1234 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-compliancesearch - - - - - - Remove-ComplianceSearchAction - Remove - ComplianceSearchAction - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-ComplianceSearchAction - - 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) - - ComplianceSearchActionIdParameter - - ComplianceSearchActionIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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) - - ComplianceSearchActionIdParameter - - ComplianceSearchActionIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ComplianceSearchAction -Identity "Case 1234_Preview" - - This example removes the compliance search action named `Case 1234_Preview`. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-compliancesearchaction - - - - - - Remove-ComplianceSecurityFilter - Remove - ComplianceSecurityFilter - - This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-ComplianceSecurityFilter - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ComplianceSecurityFilter -FilterName "HR Filter" - - This example removes the compliance security filter named HR Filter. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-compliancesecurityfilter - - - - - - Remove-eDiscoveryCaseAdmin - Remove - eDiscoveryCaseAdmin - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-eDiscoveryCaseAdmin - - 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 - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-eDiscoveryCaseAdmin -User chris@contoso.com - - This example removes an eDiscovery Administrator. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-ediscoverycaseadmin - - - - - - Remove-MailboxSearch - Remove - MailboxSearch - - This cmdlet is available in 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 Center PowerShell instead. For more information, see Retirement of legacy eDiscovery tools (https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In on-premises Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. You can't remove an In-Place Hold without first disabling the hold. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MailboxSearch - - Identity - - The Identity parameter specifies the name of the mailbox search. - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the mailbox search. - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MailboxSearch -Identity "Project Contoso" - - This example removes the mailbox search Project Contoso. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mailboxsearch - - - - - - Remove-RetentionPolicy - Remove - RetentionPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-RetentionPolicy - - Identity - - The Identity parameter specifies the retention policy name. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the retention policy name. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-retentionpolicy - - - - - - Remove-RetentionPolicyTag - Remove - RetentionPolicyTag - - This cmdlet is available in 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-RetentionPolicyTag cmdlet to remove a retention tag. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Retention tags are added to a retention policy, which is applied to a mailbox. - When you use the Remove-RetentionPolicyTag cmdlet to remove a retention tag, it removes the tag definition stored in Active Directory. The next time the Managed Folder Assistant runs, it processes all items that have the removed tag applied and restamps them. Depending on the number of mailboxes and messages, this process may result in significant resource consumption on all Mailbox servers that contain mailboxes with a retention policy that includes the removed tag. - For more information about retention tags, see Retention tags and retention policies in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-RetentionPolicyTag - - Identity - - The Identity parameter specifies the name of the retention policy tag. - - RetentionPolicyTagIdParameter - - RetentionPolicyTagIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the retention policy tag. - - RetentionPolicyTagIdParameter - - RetentionPolicyTagIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-RetentionPolicyTag -Identity "Finance-DeletedItems" - - This example removes the retention tag Finance-DeletedItems. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-retentionpolicytag - - - - - - Restore-RecoverableItems - Restore - RecoverableItems - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Items are restored to the original folder location if the information is available for the item. If the information can't be found, the item is restored to the default folder for the item type (Inbox for messages, Calendar for meetings and appointments, etc.). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Restore-RecoverableItems - - 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"`. - - GeneralMailboxOrMailUserIdParameter[] - - GeneralMailboxOrMailUserIdParameter[] - - - None - - - 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.). - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - LastParentFolderID - - The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - NoOutput - - This parameter is available only in the cloud-based service. - The NoOutput switch specifies whether to restore the deleted items directly without any command output in the console. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 will search all of these folders. - - - DeletedItems | RecoverableItems | PurgedItems - DeletedItems | RecoverableItems | PurgedItems - - RecoverableItemsFolderType - - RecoverableItemsFolderType - - - None - - - 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 ("). - - String - - String - - - None - - - - - - 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"`. - - GeneralMailboxOrMailUserIdParameter[] - - GeneralMailboxOrMailUserIdParameter[] - - - None - - - 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.). - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - LastParentFolderID - - The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - NoOutput - - This parameter is available only in the cloud-based service. - The NoOutput switch specifies whether to restore the deleted items directly without any command output in the console. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 will search all of these folders. - - RecoverableItemsFolderType - - RecoverableItemsFolderType - - - None - - - 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 ("). - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - $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 -------------------------- - 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 -------------------------- - Get-RecoverableItems administrator | Restore-RecoverableItems - - This example bulk restores all the recoverable items for administrator. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Restore-RecoverableItems - - - - - - Search-AdminAuditLog - Search - AdminAuditLog - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Search-AdminAuditLog cmdlet to search the contents of the administrator audit log. Administrator audit logging records when a user or administrator makes a change in your organization (in the Exchange admin center or by using cmdlets). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 log entries are returned by default. Note : In Exchange Online PowerShell, if you don't use the StartDate or EndDate parameters, only results from the last 14 days are returned. - For more information about the structure and properties of the audit log, Administrator audit log structure (https://docs.microsoft.com/Exchange/policy-and-compliance/admin-audit-logging/log-structure). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Search-AdminAuditLog - - 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 . - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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, "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://docs.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 . - - ExDateTime - - ExDateTime - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 . - - Boolean - - Boolean - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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, "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://docs.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 . - - ExDateTime - - ExDateTime - - - None - - - StartIndex - - The StartIndex parameter specifies the position in the result set where the displayed results start. - - Int32 - - Int32 - - - None - - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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 . - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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, "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://docs.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 . - - ExDateTime - - ExDateTime - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 . - - Boolean - - Boolean - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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, "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://docs.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 . - - ExDateTime - - ExDateTime - - - None - - - StartIndex - - The StartIndex parameter specifies the position in the result set where the displayed results start. - - Int32 - - Int32 - - - None - - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/search-adminauditlog - - - - - - Search-MailboxAuditLog - Search - MailboxAuditLog - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Search-MailboxAuditLog cmdlet to search mailbox audit log entries matching the specified search terms. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Search-MailboxAuditLog cmdlet performs a synchronous search of mailbox audit logs for one or more specified mailboxes and displays search results in the Exchange Management Shell window. To search mailbox audit logs for multiple mailboxes and have the results sent by email to specified recipients, use the New-MailboxAuditLogSearch cmdlet instead. To learn more about mailbox audit logging, see Mailbox audit logging in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/mailbox-audit-logging/mailbox-audit-logging). - This cmdlet is available in Office 365 operated by 21Vianet, but it won't return any results. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Search-MailboxAuditLog - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - IncludeInactiveMailbox - - This parameter is available only in the cloud-based service. - The IncludeInactiveMailbox switch is required to include inactive mailboxes in the search. You don't need to specify a value with this switch. - An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - - SwitchParameter - - - False - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - - Search-MailboxAuditLog - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - IncludeInactiveMailbox - - This parameter is available only in the cloud-based service. - The IncludeInactiveMailbox switch is required to include inactive mailboxes in the search. You don't need to specify a value with this switch. - An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - IncludeInactiveMailbox - - This parameter is available only in the cloud-based service. - The IncludeInactiveMailbox switch is required to include inactive mailboxes in the search. You don't need to specify a value with this switch. - An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/search-mailboxauditlog - - - - - - Search-UnifiedAuditLog - Search - UnifiedAuditLog - - This cmdlet is available only in the cloud-based service. - Use the Search-UnifiedAuditLog cmdlet to search the unified audit log. This log contains events from Exchange Online, SharePoint Online, OneDrive for Business, Azure Active Directory, Microsoft Teams, Power BI, and other Microsoft 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center. For more information, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - If you want to programmatically download data from the Microsoft 365 audit log, we recommend that you use the Microsoft 365 Management Activity API instead of using the Search-UnifiedAuditLog cmdlet in a PowerShell script. The Microsoft 365 Management Activity API is a REST web service that you can use to develop operations, security, and compliance monitoring solutions for your organization. For more information, see Management Activity API reference (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-reference). - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Search-UnifiedAuditLog - - 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://docs.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. - - ExDateTime - - ExDateTime - - - None - - - 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://docs.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. - - ExDateTime - - ExDateTime - - - None - - - 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. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - IPAddresses - - The IPAddresses parameter filters the log entries by the specified IP addresses. You specify multiple IP addresses separated by commas. - - String[] - - String[] - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - Operations - - The Operations parameter filters the log entries by operation. The available values for this parameter depend on the RecordType value. For a list of the available values for this parameter, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - RecordType - - The RecordType parameter filters the log entries by record type. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - - AuditLogRecordType - - AuditLogRecordType - - - None - - - ResultSize - - The ResultSize parameter specifies the maximum number of results to return. The default value is 100, maximum is 5,000. - - Int32 - - Int32 - - - None - - - SessionCommand - - The SessionCommand parameter specifies how much information is returned and how it's organized. 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. - - UnifiedAuditSessionCommand - - UnifiedAuditSessionCommand - - - None - - - 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. - - String - - String - - - None - - - SiteIds - - The SiteIds parameter filters the log entries by site ID. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - UserIds - - The UserIds parameter filters the log entries by 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"`. - - String[] - - String[] - - - None - - - - - - 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://docs.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. - - ExDateTime - - ExDateTime - - - None - - - 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://docs.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. - - ExDateTime - - ExDateTime - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - IPAddresses - - The IPAddresses parameter filters the log entries by the specified IP addresses. You specify multiple IP addresses separated by commas. - - String[] - - String[] - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - Operations - - The Operations parameter filters the log entries by operation. The available values for this parameter depend on the RecordType value. For a list of the available values for this parameter, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - RecordType - - The RecordType parameter filters the log entries by record type. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - - AuditLogRecordType - - AuditLogRecordType - - - None - - - ResultSize - - The ResultSize parameter specifies the maximum number of results to return. The default value is 100, maximum is 5,000. - - Int32 - - Int32 - - - None - - - SessionCommand - - The SessionCommand parameter specifies how much information is returned and how it's organized. 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. - - UnifiedAuditSessionCommand - - UnifiedAuditSessionCommand - - - None - - - 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. - - String - - String - - - None - - - SiteIds - - The SiteIds parameter filters the log entries by site ID. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - UserIds - - The UserIds parameter filters the log entries by 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"`. - - String[] - - String[] - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 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 -------------------------- - Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -SessionId "UnifiedAuditLogSearch 05/08/17" -SessionCommand ReturnLargeSet - - This example searches the unified audit log for all events from May 1, 2018 to May 8, 2018. If you don't include a time stamp in the StartDate or EndDate parameters, The data is returned in pages as the command is rerun sequentially while using the same SessionId value. 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 -------------------------- - Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -RecordType SharePointFileOperation -Operations FileAccessed -SessionId "WordDocs_SharepointViews"-SessionCommand ReturnLargeSet - - This example searches the unified audit log for any files accessed in SharePoint Online from May 1, 2018 to May 8, 2018. The data is returned in pages as the command is rerun sequentially while using the same SessionId value. - - - - -------------------------- Example 5 -------------------------- - Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -ObjectIDs "https://alpinehouse.sharepoint.com/sites/contoso/Departments/SM/International/Shared Documents/Sales Invoice - International.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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/search-unifiedauditlog - - - - - - Set-AdminAuditLogConfig - Set - AdminAuditLogConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AdminAuditLogConfig - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - UnifiedAuditLogIngestionEnabled - - This parameter is available or functional only in the cloud-based service. - The UnifiedAuditLogIngestionEnabled parameter specifies whether to enable or disable the recording of user and admin activities in the Microsoft 365 audit log. Valid values are: - - $true: User and admin activities are recorded in the Microsoft 365 audit log, and you can search the Microsoft 365 audit log. - - $false: User and admin activities aren't recorded in the Microsoft 365 audit log, and you can't search the Microsoft 365 audit log. This is the default value. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - UnifiedAuditLogIngestionEnabled - - This parameter is available or functional only in the cloud-based service. - The UnifiedAuditLogIngestionEnabled parameter specifies whether to enable or disable the recording of user and admin activities in the Microsoft 365 audit log. Valid values are: - - $true: User and admin activities are recorded in the Microsoft 365 audit log, and you can search the Microsoft 365 audit log. - - $false: User and admin activities aren't recorded in the Microsoft 365 audit log, and you can't search the Microsoft 365 audit log. This is the default value. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-adminauditlogconfig - - - - - - Set-ComplianceCase - Set - ComplianceCase - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-ComplianceCase - - 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) - - ComplianceCaseIdParameter - - ComplianceCaseIdParameter - - - None - - - CaseType - - This parameter is reserved for internal Microsoft use. - - ComplianceCaseType - - ComplianceCaseType - - - None - - - Close - - The Close switch specifies that you want to close the compliance case. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - ExternalId - - The ExternalId parameter specifies an optional ID or external case number that you can associate with the compliance case. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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) - - ComplianceCaseIdParameter - - ComplianceCaseIdParameter - - - None - - - CaseType - - This parameter is reserved for internal Microsoft use. - - ComplianceCaseType - - ComplianceCaseType - - - None - - - Close - - The Close switch specifies that you want to close the compliance case. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - ExternalId - - The ExternalId parameter specifies an optional ID or external case number that you can associate with the compliance case. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-compliancecase - - - - - - Set-ComplianceSearch - Set - ComplianceSearch - - This cmdlet is available in 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 Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.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, and not to the Organization Management role group. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-ComplianceSearch - - 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 - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - 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. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - AddOneDriveLocation - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - AddOneDriveLocationExclusion - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - 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 - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - Description - - The Description parameter specifies a description for the compliance search. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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"`. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - 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. - - - SwitchParameter - - - 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 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. - - String[] - - String[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Language - - The Language parameter specifies the language for the compliance search. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - Name - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - RefinerNames - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - 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. - - String[] - - String[] - - - None - - - 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, use the email address. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - RemovePublicFolderLocation - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - RemoveSharePointLocation - - This parameter is available only in the cloud-based service. - The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - RemoveSharePointLocationExclusion - - This parameter is available only in the cloud-based service. - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - SharePointLocation - - This parameter is available only in the cloud-based service. - The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - SharePointLocationExclusion - - This parameter is available only in the cloud-based service. - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - 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. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - AddOneDriveLocation - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - AddOneDriveLocationExclusion - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - 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 - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - Description - - The Description parameter specifies a description for the compliance search. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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"`. - - String[] - - String[] - - - None - - - 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 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. - - String[] - - String[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 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. - - String[] - - String[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Language - - The Language parameter specifies the language for the compliance search. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - Name - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - RefinerNames - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - 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. - - String[] - - String[] - - - None - - - 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, use the email address. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - RemovePublicFolderLocation - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - RemoveSharePointLocation - - This parameter is available only in the cloud-based service. - The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - RemoveSharePointLocationExclusion - - This parameter is available only in the cloud-based service. - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - SharePointLocation - - This parameter is available only in the cloud-based service. - The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - SharePointLocationExclusion - - This parameter is available only in the cloud-based service. - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String[] - - String[] - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-compliancesearch - - - - - - Set-ComplianceSearchAction - Set - ComplianceSearchAction - - This cmdlet is available or functional only in on-premises Exchange. - Use the Set-ComplianceSearchAction cmdlet to change the export key on export compliance search actions in on-premises Exchange. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.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, and not to the Organization Management role group. - - - - Set-ComplianceSearchAction - - 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) - - ComplianceSearchActionIdParameter - - ComplianceSearchActionIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - ComplianceSearchActionIdParameter - - ComplianceSearchActionIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-compliancesearchaction - - - - - - Set-ComplianceSecurityFilter - Set - ComplianceSecurityFilter - - This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-ComplianceSecurityFilter - - 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 ("). - - String - - String - - - None - - - 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 Microsoft 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. - - ComplianceSecurityFilterActionType - - ComplianceSecurityFilterActionType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - 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://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). - 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 Server (https://docs.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. - You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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 Microsoft 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. - - ComplianceSecurityFilterActionType - - ComplianceSecurityFilterActionType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - 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://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). - 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 Server (https://docs.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. - You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-compliancesecurityfilter - - - - - - Set-MailboxAuditBypassAssociation - Set - MailboxAuditBypassAssociation - - This cmdlet is available in 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-MailboxAuditBypassAssociation cmdlet to configure mailbox audit logging bypass for user or computer accounts such as service accounts for applications that access mailboxes frequently. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - If you use mailbox audit logging to audit mailbox access and actions, you must monitor mailbox audit bypass associations at regular intervals. If a mailbox audit bypass association is added for an account, the account can access any mailbox in the organization to which it has been assigned access permissions, without any mailbox audit logging entries being generated for such access, or any actions taken such as message deletions. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxAuditBypassAssociation - - Identity - - The Identity parameter specifies a user or computer account to be bypassed from mailbox audit logging. - - MailboxAuditBypassAssociationIdParameter - - MailboxAuditBypassAssociationIdParameter - - - None - - - 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 - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies a user or computer account to be bypassed from mailbox audit logging. - - MailboxAuditBypassAssociationIdParameter - - MailboxAuditBypassAssociationIdParameter - - - None - - - 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 - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-MailboxAuditBypassAssociation -Identity "Svc-MyApplication" -AuditBypassEnabled $true - - This example bypasses the Svc-MyApplication account from mailbox audit logging. - - - - -------------------------- Example 2 -------------------------- - Set-MailboxAuditBypassAssociation -Identity "Svc-MyApplication" -AuditBypassEnabled $false - - This example removes the bypass association for the Svc-MyApplication account. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation - - - - - - Set-Mailboxsearch - Set - Mailboxsearch - - This cmdlet is available in 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-MailboxSearch cmdlet to modify an existing mailbox search. Note : As of October 2020, the \ -MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \ -ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see Retirement of legacy eDiscovery tools (https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/holds/holds). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-Mailboxsearch - - Identity - - The Identity parameter specifies the name of the mailbox search that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - 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]). - - Boolean - - Boolean - - - None - - - 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]). - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies a description for the search. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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. - - ExDateTime - - ExDateTime - - - None - - - 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. - - - SwitchParameter - - - False - - - ExcludeDuplicateMessages - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - IncludeUnsearchableItems - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Language - - The Language parameter specifies a locale for the mailbox search. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - LogLevel - - 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. - - LoggingLevel - - LoggingLevel - - - None - - - 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. To clear all specified values, use the value $null. - - KindKeyword[] - - KindKeyword[] - - - None - - - Name - - The Name parameter specifies a name for the search. If the value contains spaces, enclose the value in quotation marks ("). - The value of this parameter is used to create the top-level folder that holds the search results in the target mailbox that's specified by the TargetMailbox parameter. - - String - - String - - - None - - - Recipients - - The Recipients parameter specifies one or more recipients include in the search query. Messages that have the specified recipients in the To, Cc, and Bcc fields are returned in the search results. - You can specify multiple recipients separated by commas. If the value contains spaces, enclose the value in quotation marks ("). - To clear the recipients, use the value $null. - - String[] - - String[] - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - 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 - - String - - String - - - None - - - 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 ("). - To clear the senders, use the value $null. - - String[] - - String[] - - - None - - - SourceMailboxes - - The SourceMailboxes parameter specifies the 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). - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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. - - ExDateTime - - ExDateTime - - - None - - - StatisticsStartIndex - - The StatisticsStartIndex parameter is used by the Exchange admin center (EAC) to retrieve keyword statistics in a paged operation. - - Int32 - - Int32 - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the mailbox search that you want to modify. If the value contains spaces, enclose the value in quotation marks ("). - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - 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]). - - Boolean - - Boolean - - - None - - - 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]). - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies a description for the search. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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. - - ExDateTime - - ExDateTime - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ExcludeDuplicateMessages - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - IncludeUnsearchableItems - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Language - - The Language parameter specifies a locale for the mailbox search. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - LogLevel - - 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. - - LoggingLevel - - LoggingLevel - - - None - - - 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. To clear all specified values, use the value $null. - - KindKeyword[] - - KindKeyword[] - - - None - - - Name - - The Name parameter specifies a name for the search. If the value contains spaces, enclose the value in quotation marks ("). - The value of this parameter is used to create the top-level folder that holds the search results in the target mailbox that's specified by the TargetMailbox parameter. - - String - - String - - - None - - - Recipients - - The Recipients parameter specifies one or more recipients include in the search query. Messages that have the specified recipients in the To, Cc, and Bcc fields are returned in the search results. - You can specify multiple recipients separated by commas. If the value contains spaces, enclose the value in quotation marks ("). - To clear the recipients, use the value $null. - - String[] - - String[] - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - 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 - - String - - String - - - None - - - 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 ("). - To clear the senders, use the value $null. - - String[] - - String[] - - - None - - - SourceMailboxes - - The SourceMailboxes parameter specifies the 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). - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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. - - ExDateTime - - ExDateTime - - - None - - - StatisticsStartIndex - - The StatisticsStartIndex parameter is used by the Exchange admin center (EAC) to retrieve keyword statistics in a paged operation. - - Int32 - - Int32 - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-MailboxSearch -Identity "Legal-ProjectX" -StartDate "01/01/2016" - - This example modifies the start date of a mailbox search. - - - - -------------------------- Example 2 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxsearch - - - - - - Set-RetentionPolicy - Set - RetentionPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-RetentionPolicy - - Identity - - The Identity parameter specifies the name, distinguished name (DN), or GUID of the retention policy. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Force - - The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter. - - - SwitchParameter - - - False - - - IsDefault - - This parameter is available only in the cloud-based service. - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Name - - The Name parameter specifies a unique name for the retention policy. - - String - - String - - - None - - - 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. - - Guid - - Guid - - - None - - - 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. - - RetentionPolicyTagIdParameter[] - - RetentionPolicyTagIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name, distinguished name (DN), or GUID of the retention policy. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Force - - The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter. - - SwitchParameter - - SwitchParameter - - - False - - - IsDefault - - This parameter is available only in the cloud-based service. - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Name - - The Name parameter specifies a unique name for the retention policy. - - String - - String - - - None - - - 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. - - Guid - - Guid - - - None - - - 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. - - RetentionPolicyTagIdParameter[] - - RetentionPolicyTagIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 About Parameters (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-retentionpolicy - - - - - - Set-RetentionPolicyTag - Set - RetentionPolicyTag - - This cmdlet is available in 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-RetentionPolicyTag cmdlet to modify the properties of a retention tag. - For more information about retention tags, see Retention tags and retention policies in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Retention tags are used to apply message retention settings to folders and items in a mailbox. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-RetentionPolicyTag - - Identity - - The Identity parameter specifies the name, distinguished name (DN), or GUID of the retention policy tag to be modified. - - RetentionPolicyTagIdParameter - - RetentionPolicyTagIdParameter - - - None - - - AgeLimitForRetention - - The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - Comment - - The Comment parameter specifies a comment for the retention policy tag. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Force - - The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter. - - - SwitchParameter - - - False - - - LegacyManagedFolder - - The LegacyManagedFolder parameter specifies the name of a managed folder. The retention tag is created by using retention settings from the managed folder and its managed content settings. You can use this parameter to create retention tags based on existing managed folders to migrate users from managed folder mailbox policies to retention policies. - - ELCFolderIdParameter - - ELCFolderIdParameter - - - None - - - LocalizedComment - - The LocalizedComment parameter specifies the localized comment and language for the retention policy tag. This comment is displayed in Microsoft Outlook based on the user's locale. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - LocalizedRetentionPolicyTagName - - The LocalizedRetentionPolicyTagName parameter specifies a localized name for the retention policy tag. This name is displayed in Outlook based on the user's locale. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MessageClass - - The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to *. - With the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of * are supported and they apply to all message types. - To create a DPT for voice mail messages, set the MessageClass parameter to voicemail and the Type parameter to All. - A DPT for voice mail messages applies only to Microsoft Exchange Unified Messaging voice mail messages (identified by the PR_MESSAGE_CLASS MAPI property value IPM.Note.Microsoft.Voicemail*). - - String - - String - - - None - - - MustDisplayCommentEnabled - - The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the name of the retention policy tag. - - String - - String - - - None - - - RetentionAction - - 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). - If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. - - RetentionAction - - RetentionAction - - - None - - - 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. - 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>`. - - Boolean - - Boolean - - - None - - - 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). - 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. - - Guid - - Guid - - - None - - - SystemTag - - The SystemTag parameter specifies whether the retention policy tag is created for internal Exchange functionality. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-RetentionPolicyTag - - Mailbox - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Comment - - The Comment parameter specifies a comment for the retention policy tag. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Force - - The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter. - - - SwitchParameter - - - False - - - LegacyManagedFolder - - The LegacyManagedFolder parameter specifies the name of a managed folder. The retention tag is created by using retention settings from the managed folder and its managed content settings. You can use this parameter to create retention tags based on existing managed folders to migrate users from managed folder mailbox policies to retention policies. - - ELCFolderIdParameter - - ELCFolderIdParameter - - - None - - - LocalizedComment - - The LocalizedComment parameter specifies the localized comment and language for the retention policy tag. This comment is displayed in Microsoft Outlook based on the user's locale. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - LocalizedRetentionPolicyTagName - - The LocalizedRetentionPolicyTagName parameter specifies a localized name for the retention policy tag. This name is displayed in Outlook based on the user's locale. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MustDisplayCommentEnabled - - The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the name of the retention policy tag. - - String - - String - - - None - - - OptionalInMailbox - - 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. - - RetentionPolicyTagIdParameter[] - - RetentionPolicyTagIdParameter[] - - - None - - - 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). - 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. - - Guid - - Guid - - - None - - - SystemTag - - The SystemTag parameter specifies whether the retention policy tag is created for internal Exchange functionality. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name, distinguished name (DN), or GUID of the retention policy tag to be modified. - - RetentionPolicyTagIdParameter - - RetentionPolicyTagIdParameter - - - None - - - Mailbox - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - AgeLimitForRetention - - The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - Comment - - The Comment parameter specifies a comment for the retention policy tag. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Force - - The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter. - - SwitchParameter - - SwitchParameter - - - False - - - LegacyManagedFolder - - The LegacyManagedFolder parameter specifies the name of a managed folder. The retention tag is created by using retention settings from the managed folder and its managed content settings. You can use this parameter to create retention tags based on existing managed folders to migrate users from managed folder mailbox policies to retention policies. - - ELCFolderIdParameter - - ELCFolderIdParameter - - - None - - - LocalizedComment - - The LocalizedComment parameter specifies the localized comment and language for the retention policy tag. This comment is displayed in Microsoft Outlook based on the user's locale. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - LocalizedRetentionPolicyTagName - - The LocalizedRetentionPolicyTagName parameter specifies a localized name for the retention policy tag. This name is displayed in Outlook based on the user's locale. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MessageClass - - The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to *. - With the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of * are supported and they apply to all message types. - To create a DPT for voice mail messages, set the MessageClass parameter to voicemail and the Type parameter to All. - A DPT for voice mail messages applies only to Microsoft Exchange Unified Messaging voice mail messages (identified by the PR_MESSAGE_CLASS MAPI property value IPM.Note.Microsoft.Voicemail*). - - String - - String - - - None - - - MustDisplayCommentEnabled - - The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the name of the retention policy tag. - - String - - String - - - None - - - OptionalInMailbox - - 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. - - RetentionPolicyTagIdParameter[] - - RetentionPolicyTagIdParameter[] - - - None - - - RetentionAction - - 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). - If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned. - - RetentionAction - - RetentionAction - - - None - - - 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. - 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>`. - - Boolean - - Boolean - - - None - - - 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). - 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. - - Guid - - Guid - - - None - - - SystemTag - - The SystemTag parameter specifies whether the retention policy tag is created for internal Exchange functionality. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB" - - This example makes optional retention tags available to user Terry Adams using the Mailbox and OptionalInMailbox parameters. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-retentionpolicytag - - - - - - Start-ComplianceSearch - Start - ComplianceSearch - - This cmdlet is available in 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 Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.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, and not to the Organization Management role group. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Start-ComplianceSearch - - 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 - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Start-ComplianceSearch -Identity "Case 1234" - - This example starts the compliance search named Case 1234 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/start-compliancesearch - - - - - - Start-MailboxSearch - Start - MailboxSearch - - This cmdlet is available in 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 Center PowerShell instead. For more information, see Retirement of legacy eDiscovery tools (https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/Exchange/policy-and-compliance/holds/holds) and [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Start-MailboxSearch - - Identity - - The Identity parameter specifies the name of the search. The name is referenced when starting, stopping, or removing the search. - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - StatisticsStartIndex - - The StatisticsStartIndex parameter is used by the EAC to retrieve keyword statistics in a paged operation. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the search. The name is referenced when starting, stopping, or removing the search. - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - StatisticsStartIndex - - The StatisticsStartIndex parameter is used by the EAC to retrieve keyword statistics in a paged operation. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Start-MailboxSearch -Identity "ProjectContoso" - - This example starts the mailbox search ProjectContoso. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/start-mailboxsearch - - - - - - Start-ManagedFolderAssistant - Start - ManagedFolderAssistant - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Start-ManagedFolderAssistant - - 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) - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - 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://docs.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). - - - SwitchParameter - - - False - - - AggMailboxCleanup - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - InactiveMailbox - - This parameter is available only in the cloud-based service. - The InactiveMailbox switch runs the command only 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Start-ManagedFolderAssistant - - 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) - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - 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://docs.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). - - - SwitchParameter - - - False - - - AggMailboxCleanup - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Start-ManagedFolderAssistant - - 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) - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - AggMailboxCleanup - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - InactiveMailbox - - This parameter is available only in the cloud-based service. - The InactiveMailbox switch runs the command only 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. - - - SwitchParameter - - - False - - - StopHoldCleanup - - This parameter is available only in the cloud-based service. - The StopHoldCleanup parameter 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxOrMailUserIdParameter - - MailboxOrMailUserIdParameter - - - None - - - 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://docs.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). - - SwitchParameter - - SwitchParameter - - - False - - - AggMailboxCleanup - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - InactiveMailbox - - This parameter is available only in the cloud-based service. - The InactiveMailbox switch runs the command only 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. - - SwitchParameter - - SwitchParameter - - - False - - - StopHoldCleanup - - This parameter is available only in the cloud-based service. - The StopHoldCleanup parameter 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/start-managedfolderassistant - - - Export-MailboxDiagnosticLogs - https://docs.microsoft.com/powershell/module/exchange/Export-MailboxDiagnosticLogs - - - - - - Stop-ComplianceSearch - Stop - ComplianceSearch - - This cmdlet is available in 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 Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.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 and not to the Organization Management role group. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Stop-ComplianceSearch - - 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 - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceSearchIdParameter - - ComplianceSearchIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Stop-ComplianceSearch -Identity "Case 1234" - - This example stops the active compliance search named Case 1234 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/stop-compliancesearch - - - - - - Stop-MailboxSearch - Stop - MailboxSearch - - This cmdlet is available in 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 Center PowerShell instead. For more information, see Retirement of legacy eDiscovery tools (https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In Microsoft Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. You can start and stop a mailbox search. For more information, see In-Place eDiscovery in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Stop-MailboxSearch - - Identity - - The Identity parameter specifies the name of the mailbox search. - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the mailbox search. - - SearchObjectIdParameter - - SearchObjectIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Stop-MailboxSearch -Identity "Project Contoso" - - This example stops the mailbox search Project Contoso. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/stop-mailboxsearch - - - - - - Update-ComplianceCaseMember - Update - ComplianceCaseMember - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Update-ComplianceCaseMember - - 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. - - String - - String - - - None - - - 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"`. - - String[] - - String[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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"`. - - String[] - - String[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/update-compliancecasemember - - - - - - Update-eDiscoveryCaseAdmin - Update - eDiscoveryCaseAdmin - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Update-eDiscoveryCaseAdmin - - 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"`. - - String[] - - String[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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"`. - - String[] - - String[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Update-eDiscoveryCaseAdmin -Users laura@contoso.com,julia@contoso.com - - This example replaces the existing eDiscovery Administrators with new users. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/update-ediscoverycaseadmin - - - - - - Write-AdminAuditLog - Write - AdminAuditLog - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Write-AdminAuditLog - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Write-AdminAuditLog -Comment "Ran custom script." - - This example adds a comment to the administrator audit log. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/write-adminauditlog - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.RemoteConnections-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.RemoteConnections-Help.xml deleted file mode 100644 index 802737e1c669..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.RemoteConnections-Help.xml +++ /dev/null @@ -1,12405 +0,0 @@ - - - - - Disable-OutlookProtectionRule - Disable - OutlookProtectionRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Outlook protection rules are administrator-created rules applied before a user sends a message using Outlook. Outlook protection rules are used to automatically Information Rights Management (IRM)-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. - For more information, see Outlook protection rules (https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-OutlookProtectionRule - - Identity - - The Identity parameter specifies the name of the rule being disabled. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the rule being disabled. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-OutlookProtectionRule -Identity "Project Contoso" - - This example disables the Outlook protection rule Project Contoso. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-outlookprotectionrule - - - - - - Enable-OutlookProtectionRule - Enable - OutlookProtectionRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Outlook protection rules are used to automatically Information Rights Management (IRM)-protect messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see Outlook protection rules (https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-OutlookProtectionRule - - Identity - - The Identity parameter specifies the name of the rule being enabled. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the rule being enabled. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-OutlookProtectionRule -Identity "Project Contoso" - - This example enables the Outlook protection rule Project Contoso. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-outlookprotectionrule - - - - - - Get-AcceptedDomain - Get - AcceptedDomain - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AcceptedDomain - - Identity - - The Identity parameter specifies a string value for the accepted domain. Enter either the GUID or the name of the accepted domain. - - AcceptedDomainIdParameter - - AcceptedDomainIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies a string value for the accepted domain. Enter either the GUID or the name of the accepted domain. - - AcceptedDomainIdParameter - - AcceptedDomainIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-accepteddomain - - - - - - Get-ClassificationRuleCollection - Get - ClassificationRuleCollection - - This cmdlet is available in 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 Security & Compliance Center, use the Get-DlpSensitiveInformationTypeRulePackage cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ClassificationRuleCollection - - 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. - - ClassificationRuleCollectionIdParameter - - ClassificationRuleCollectionIdParameter - - - None - - - - - - 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. - - ClassificationRuleCollectionIdParameter - - ClassificationRuleCollectionIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-classificationrulecollection - - - - - - Get-HybridMailflow - Get - HybridMailflow - - This cmdlet is available only in the cloud-based service. Note : This cmdlet has been deprecated and is no longer used. - Use the Get-HybridMailflow cmdlet to view the message transport settings for a hybrid deployment. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-HybridMailflow - - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-HybridMailflow - - This example returns the message transport settings for the hybrid deployment. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-hybridmailflow - - - - - - Get-HybridMailflowDatacenterIPs - Get - HybridMailflowDatacenterIPs - - This cmdlet is available only in the cloud-based service. Note : This cmdlet has been deprecated and is no longer used. - Use the Get-HybridMailflowDatacenterIPs cmdlet to retrieve the IP addresses of the Microsoft Exchange Online Protection (EOP) service data centers. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-HybridMailflowDatacenterIPs - - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-HybridMailflowDatacenterIPs - - This example returns IP address information for EOP service data centers that support hybrid deployments. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-hybridmailflowdatacenterips - - - - - - Get-MessageClassification - Get - MessageClassification - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MessageClassification - - 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<Name>` or `<Locale><Name>`; for example, "Default\My Message Classification" or "es-ES\My Message Classification". - - ClassificationID (GUID) - - MessageClassificationIdParameter - - MessageClassificationIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - 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<Name>` or `<Locale><Name>`; for example, "Default\My Message Classification" or "es-ES\My Message Classification". - - ClassificationID (GUID) - - MessageClassificationIdParameter - - MessageClassificationIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MessageClassification - - This example lists all message classifications in your organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-messageclassification - - - - - - Get-OrganizationConfig - Get - OrganizationConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OrganizationConfig - - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 cloud-based organization. - For more information, see Troubleshoot a hybrid deployment (https://docs.microsoft.com/exchange/hybrid-deployment/troubleshoot-a-hybrid-deployment). - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-organizationconfig - - - - - - Get-OutlookProtectionRule - Get - OutlookProtectionRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Outlook protection rules are used to automatically Information Rights Management (IRM)-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To IRM-protect messages based on message content, use transport protection rules. For more information, see Outlook protection rules (https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OutlookProtectionRule - - Identity - - The Identity parameter identifies an Outlook protection rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - - - - Identity - - The Identity parameter identifies an Outlook protection rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-outlookprotectionrule - - - - - - Get-RemoteDomain - Get - RemoteDomain - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RemoteDomain - - 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 - - RemoteDomainIdParameter - - RemoteDomainIdParameter - - - None - - - - - - 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 - - RemoteDomainIdParameter - - RemoteDomainIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-remotedomain - - - - - - Get-RMSTrustedPublishingDomain - Get - RMSTrustedPublishingDomain - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - - - - Get-RMSTrustedPublishingDomain - - 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 - - RmsTrustedPublishingDomainIdParameter - - RmsTrustedPublishingDomainIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - RmsTrustedPublishingDomainIdParameter - - RmsTrustedPublishingDomainIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-rmstrustedpublishingdomain - - - - - - Get-TransportConfig - Get - TransportConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-TransportConfig cmdlet displays configuration information for global transport settings applied across the organization when the cmdlet is run on a Mailbox server. When this cmdlet is run on an Edge Transport server, only the transportation configuration settings for the local computer are shown. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-TransportConfig - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-transportconfig - - - - - - Import-ContactList - Import - ContactList - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Import-ContactList - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - CSV - - The CSV parameter simply specifies that the contacts will be imported from a .csv file. - - - SwitchParameter - - - 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"))`. - - Byte[] - - Byte[] - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Import-ContactList - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - CSV - - The CSV parameter simply specifies that the contacts will be imported from a .csv file. - - - SwitchParameter - - - False - - - CSVStream - - This parameter is reserved for internal Microsoft use. - - Stream - - Stream - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - CSV - - The CSV parameter simply specifies that the contacts will be imported from a .csv file. - - SwitchParameter - - SwitchParameter - - - 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"))`. - - Byte[] - - Byte[] - - - None - - - CSVStream - - This parameter is reserved for internal Microsoft use. - - Stream - - Stream - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/import-contactlist - - - - - - Import-RMSTrustedPublishingDomain - Import - RMSTrustedPublishingDomain - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Import-RMSTrustedPublishingDomain - - 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. - - String - - String - - - None - - - 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`. - - Uri - - Uri - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - 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`. - - Uri - - Uri - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Import-RMSTrustedPublishingDomain - - 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. - - String - - String - - - None - - - 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`. - - Uri - - Uri - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - 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`. - - Uri - - Uri - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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`. - - Uri - - Uri - - - None - - - 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`. - - Uri - - Uri - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Import-RMSTrustedPublishingDomain - - 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. - - String - - String - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Import-RMSTrustedPublishingDomain - - 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. - - String - - String - - - None - - - RMSOnline - - The RMSOnline switch specifies that the TPD is imported from RMS Online. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - By default, the value of the ExtranetLicensingUrl parameter is `https://<FQDN>/_wmcs/licensing`. - - Uri - - Uri - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - 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`. - - Uri - - Uri - - - None - - - 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. - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - RMSOnline - - The RMSOnline switch specifies that the TPD is imported from RMS Online. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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`. - - Uri - - Uri - - - None - - - 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`. - - Uri - - Uri - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/import-rmstrustedpublishingdomain - - - - - - New-ClassificationRuleCollection - New - ClassificationRuleCollection - - This cmdlet is available in 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 Security & Compliance Center, use the New-DlpSensitiveInformationTypeRulePackage cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-ClassificationRuleCollection - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-classificationrulecollection - - - - - - New-MessageClassification - New - MessageClassification - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MessageClassification - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - SenderDescription - - The SenderDescription parameter specifies the 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 ("). - - String - - String - - - None - - - 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 `<MessageClassificationName>` with the name of the message classification and run the following command: `Get-MessageClassification -Identity "<MessageClassificationName>"`. - - Guid - - Guid - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - ClassificationDisplayPrecedenceLevel - - ClassificationDisplayPrecedenceLevel - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDescription - - The RecipientDescription parameter specifies the 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - SenderDescription - - The SenderDescription parameter specifies the 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 ("). - - String - - String - - - None - - - 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 `<MessageClassificationName>` with the name of the message classification and run the following command: `Get-MessageClassification -Identity "<MessageClassificationName>"`. - - Guid - - Guid - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - ClassificationDisplayPrecedenceLevel - - ClassificationDisplayPrecedenceLevel - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDescription - - The RecipientDescription parameter specifies the 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-messageclassification - - - - - - New-OutlookProtectionRule - New - OutlookProtectionRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-OutlookProtectionRule - - Name - - The Name parameter specifies a name for the rule. - - String - - String - - - None - - - 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. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - FromDepartment - - The FromDepartment parameter specifies the sender's department as a condition. The user's department property is compared with the value specified. - - String[] - - String[] - - - None - - - Priority - - The Priority parameter specifies whether to set the order of processing of Outlook protection rules. Rules with a lower priority value are executed first. - - Int32 - - Int32 - - - None - - - SentTo - - The SentTo parameter specifies one or more recipients as a rule condition. You can use any value that uniquely identifies the internal recipient. For example: - - Name - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SentToScope - - 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. - - ToUserScope - - ToUserScope - - - None - - - UserCanOverride - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - Name - - The Name parameter specifies a name for the rule. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enabled - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - FromDepartment - - The FromDepartment parameter specifies the sender's department as a condition. The user's department property is compared with the value specified. - - String[] - - String[] - - - None - - - Priority - - The Priority parameter specifies whether to set the order of processing of Outlook protection rules. Rules with a lower priority value are executed first. - - Int32 - - Int32 - - - None - - - SentTo - - The SentTo parameter specifies one or more recipients as a rule condition. You can use any value that uniquely identifies the internal recipient. For example: - - Name - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SentToScope - - 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. - - ToUserScope - - ToUserScope - - - None - - - UserCanOverride - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-outlookprotectionrule - - - - - - New-RemoteDomain - New - RemoteDomain - - This cmdlet is available in 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-RemoteDomain cmdlet to create a managed connection for a remote domain. When you create a remote domain, you can control mail flow with more precision, apply message formatting and messaging policies and specify acceptable character sets for messages sent to and received from the remote domain. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-RemoteDomain - - 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 ("). - - String - - String - - - None - - - 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). - - SmtpDomainWithSubdomains - - SmtpDomainWithSubdomains - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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). - - SmtpDomainWithSubdomains - - SmtpDomainWithSubdomains - - - None - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-RemoteDomain -DomainName *.contoso.com -Name Contoso - - This example creates the remote domain named Contoso for the domain contoso.com and all subdomains. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-remotedomain - - - - - - Remove-ClassificationRuleCollection - Remove - ClassificationRuleCollection - - This cmdlet is available in 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-ClassificationRuleCollection to remove classification rule collections from your organization. - In the Security & Compliance Center, use the Remove-DlpSensitiveInformationTypeRulePackage cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ClassificationRuleCollection - - Identity - - The Identity parameter specifies the classification rule collection you want to remove. You can use any value that uniquely identifies the classification rule collection. For example, you can specify the name, rule collection name or distinguished name (DN) of the classification rule collection. - - ClassificationRuleCollectionIdParameter - - ClassificationRuleCollectionIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the classification rule collection you want to remove. You can use any value that uniquely identifies the classification rule collection. For example, you can specify the name, rule collection name or distinguished name (DN) of the classification rule collection. - - ClassificationRuleCollectionIdParameter - - ClassificationRuleCollectionIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ClassificationRuleCollection "External Classification Rule Collection" - - This example removes the classification rule collection named External Classification Rule Collection from your organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-classificationrulecollection - - - - - - Remove-MessageClassification - Remove - MessageClassification - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MessageClassification - - 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<Name>` or `<Locale><Name>` (for example, `"Default\My Message Classification"` or `"es-ES\My Message Classification"`). - - ClassificationID (GUID) - - MessageClassificationIdParameter - - MessageClassificationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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<Name>` or `<Locale><Name>` (for example, `"Default\My Message Classification"` or `"es-ES\My Message Classification"`). - - ClassificationID (GUID) - - MessageClassificationIdParameter - - MessageClassificationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MessageClassification -Identity "My Message Classification" - - This example removes the message classification named "My Message Classification". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-messageclassification - - - - - - Remove-OutlookProtectionRule - Remove - OutlookProtectionRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Outlook protection rules use an Active Directory Rights Management Services (AD RMS) rights template to automatically apply Information Rights Management (IRM) protection to messages before they're sent. For more information, see Outlook protection rules (https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-OutlookProtectionRule - - Identity - - The Identity parameter specifies the name of the Outlook protection rule that you want to remove. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the Outlook protection rule that you want to remove. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-outlookprotectionrule - - - - - - Remove-RemoteDomain - Remove - RemoteDomain - - This cmdlet is available in 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-RemoteDomain cmdlet to remove a remote domain. When you remove a remote domain, the remote domain object is deleted. Removing a remote domain doesn't disable mail flow to that domain. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-RemoteDomain - - Identity - - 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 - - RemoteDomainIdParameter - - RemoteDomainIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - RemoteDomainIdParameter - - RemoteDomainIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-RemoteDomain Contoso - - This example removes the remote domain object named Contoso. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-remotedomain - - - - - - Remove-RMSTrustedPublishingDomain - Remove - RMSTrustedPublishingDomain - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - - - - Remove-RMSTrustedPublishingDomain - - 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 - - RmsTrustedPublishingDomainIdParameter - - RmsTrustedPublishingDomainIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Force - - The Force parameter forces the command to execute without asking for user confirmation. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - RmsTrustedPublishingDomainIdParameter - - RmsTrustedPublishingDomainIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Force - - The Force parameter forces the command to execute without asking for user confirmation. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-RMSTrustedPublishingDomain "Contoso TPD" - - This example removes the trusted publishing domain Contoso TPD from your organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-rmstrustedpublishingdomain - - - - - - Set-AcceptedDomain - Set - AcceptedDomain - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AcceptedDomain - - 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. - - AcceptedDomainIdParameter - - AcceptedDomainIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - AcceptedDomainType - - AcceptedDomainType - - - None - - - EnableNego2Authentication - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - PendingCompletion - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - PendingRemoval - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - AcceptedDomainIdParameter - - AcceptedDomainIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - AcceptedDomainType - - AcceptedDomainType - - - None - - - EnableNego2Authentication - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - PendingCompletion - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - PendingRemoval - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-AcceptedDomain -Identity Contoso -MakeDefault $true - - This example makes the accepted domain Contoso the default accepted domain. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-accepteddomain - - - - - - Set-ClassificationRuleCollection - Set - ClassificationRuleCollection - - This cmdlet is available in 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 Security & Compliance Center, use the Set-DlpSensitiveInformationTypeRulePackage cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ClassificationRuleCollection - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-classificationrulecollection - - - - - - Set-HybridMailflow - Set - HybridMailflow - - 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). Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Set-HybridMailflow cmdlet supports the configuration of message transport settings for hybrid deployments created with the Hybrid Configuration wizard offered in Exchange 2010 SP2. This cmdlet isn't typically used by administrators; therefore, we strongly recommend that it only be used as part of the hybrid configuration process using the Hybrid Configuration wizard. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-HybridMailflow - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - IPRange[] - - IPRange[] - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - OutboundDomains - - The OutboundDomains parameter specifies SMTP domains configured for the hybrid deployment. - - SmtpDomainWithSubdomains[] - - SmtpDomainWithSubdomains[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - IPRange[] - - IPRange[] - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - OutboundDomains - - The OutboundDomains parameter specifies SMTP domains configured for the hybrid deployment. - - SmtpDomainWithSubdomains[] - - SmtpDomainWithSubdomains[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-HybridMailflow - - This example configures the message transport settings in the EOP service for a hybrid deployment. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-hybridmailflow - - - - - - Set-MessageClassification - Set - MessageClassification - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MessageClassification - - 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<Name>` or `<Locale><Name>`; for example, `"Default\My Message Classification"` or `"es-ES\My Message Classification"`. - - ClassificationID (GUID) - - MessageClassificationIdParameter - - MessageClassificationIdParameter - - - None - - - 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 `<MessageClassificationName>` with the name of the message classification and run the following command: `Get-MessageClassification -Identity "<MessageClassificationName>"`. - - Guid - - Guid - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - ClassificationDisplayPrecedenceLevel - - ClassificationDisplayPrecedenceLevel - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDescription - - The RecipientDescription parameter specifies the 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SenderDescription - - The SenderDescription parameter specifies the 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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<Name>` or `<Locale><Name>`; for example, `"Default\My Message Classification"` or `"es-ES\My Message Classification"`. - - ClassificationID (GUID) - - MessageClassificationIdParameter - - MessageClassificationIdParameter - - - None - - - 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 `<MessageClassificationName>` with the name of the message classification and run the following command: `Get-MessageClassification -Identity "<MessageClassificationName>"`. - - Guid - - Guid - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - ClassificationDisplayPrecedenceLevel - - ClassificationDisplayPrecedenceLevel - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDescription - - The RecipientDescription parameter specifies the 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SenderDescription - - The SenderDescription parameter specifies the 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-messageclassification - - - - - - Set-OrganizationConfig - Set - OrganizationConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-OrganizationConfig - - ShortenEventScopeDefault - - This parameter is available only in the cloud-based service - {{ Fill ShortenEventScopeDefault Description }} - Valid values are: - - None (default value) - - EndEarly - - StartLate - - ShortenEventScopeMode - - ShortenEventScopeMode - - - None - - - ActivityBasedAuthenticationTimeoutEnabled - - The ActivityBasedAuthenticationTimeoutEnabled parameter specifies whether the timed logoff feature is enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled - - The ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter specifies whether to keep single sign-on enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowPlusAddressInRecipients - - This parameter is available only in the cloud-based service. - The AllowPlusAddressInRecipients parameter enables or disables dynamic, disposable subaddressing as defined in RFC 5233. Valid values are: - - $true: The plus sign in an email address indicates subaddressing. For example, mail sent to jane+exampletag@contoso.com is delivered to jane@contoso.com. For customers who enrolled in Exchange Online after September 2020, this is the default value.- $false: The plus sign in an email address is treated as a literal character. For example, mail sent to jane+exampletag@contoso.com is delivered only if jane+exampletag@contoso.com is configured as the primary address or a proxy address on an existing recipient. For customers who enrolled in Exchange Online before September 2020, this is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - AutoEnableArchiveMailbox - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - BookingsAddressEntryRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsAddressEntryRestricted Description }} - - Boolean - - Boolean - - - None - - - BookingsAuthEnabled - - This parameter is available only in the cloud-based service. - {{ Fill BookingsAuthEnabled Description }} - - Boolean - - Boolean - - - None - - - BookingsCreationOfCustomQuestionsRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsCreationOfCustomQuestionsRestricted Description }} - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BookingsExposureOfStaffDetailsRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsExposureOfStaffDetailsRestricted Description }} - - Boolean - - Boolean - - - None - - - BookingsMembershipApprovalRequired - - This parameter is available only in the cloud-based service. - {{ Fill BookingsMembershipApprovalRequired Description }} - - Boolean - - Boolean - - - None - - - BookingsNotesEntryRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsNotesEntryRestricted Description }} - - Boolean - - Boolean - - - None - - - BookingsPaymentsEnabled - - This parameter is available only in the cloud-based service. - The BookingsPaymentsEnabled parameter specifies whether to enable online payment node inside Bookings. Valid values are: - - $true: Online payments are enabled. - - $false: Online payments are disabled. This is the default value. - - Boolean - - Boolean - - - None - - - BookingsPhoneNumberEntryRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsPhoneNumberEntryRestricted Description }} - - Boolean - - Boolean - - - None - - - BookingsSocialSharingRestricted - - This parameter is available only in the cloud-based service. - The BookingsSocialSharingRestricted parameter allows you to control whether, or not, your users can see 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - CalendarVersionStoreEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - ComplianceMLBgdCrawlEnabled - - This parameter is available only in the cloud-based service. - {{ Fill ComplianceMLBgdCrawlEnabled Description }} - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - CustomerLockboxEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - 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) - - ModernGroupObjectType - - ModernGroupObjectType - - - Private - - - DefaultMinutesToReduceLongEventsBy - - This parameter is available only in the cloud-based service. - {{ Fill DefaultMinutesToReduceLongEventsBy Description }} - - Int32 - - Int32 - - - None - - - DefaultMinutesToReduceShortEventsBy - - This parameter is available only in the cloud-based service. - {{ Fill DefaultMinutesToReduceShortEventsBy Description }} - - Int32 - - Int32 - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - DefaultPublicFolderMovedItemRetention - - The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant. - When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see Set-PublicFolder (https://docs.microsoft.com/powershell/module/exchange/set-publicfolder). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DistributionGroupDefaultOU - - The DistributionGroupDefaultOU parameter specifies the container where distribution groups are created by default. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 `"prefix<GroupName>suffix"`. The value `<GroupName>` 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: - - `<City>` - - `<Company>` - - `<CountryCode>` - - `<CountryOrRegion> - - `<CustomAttribute1>` to `<CustomAttribute15>` - - `<Department>` - - `<ExtensionCustomAttribute1>` to `<ExtensionCustomAttribute5>` - - `<Office>` - - `<StateOrProvince>` - - `<Title>` - - For example: `"DL_<StateOrProvince>_<GroupName>"`, `"<StateOrProvince>-<City>-<Office>-<GroupName>"` or `"<GroupName> <CustomAttribute1>"`. - - DistributionGroupNamingPolicy - - DistributionGroupNamingPolicy - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EnableForwardingAddressSyncForMailboxes - - This parameter is available only in the cloud-based service. - {{ Fill EnableForwardingAddressSyncForMailboxes Description }} - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - EwsApplicationAccessPolicy - - EwsApplicationAccessPolicy - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - For more information about FindTime, see How to create a FindTime poll (https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). - - Boolean - - Boolean - - - None - - - 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. - - For more information about FindTime, see How to create a FindTime poll (https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). - - Boolean - - Boolean - - - None - - - 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. - For more information about FindTime, see How to create a FindTime poll (https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UserContactGroupIdParameter - - UserContactGroupIdParameter - - - None - - - 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, 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - IsAgendaMailEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - MailTipsAllTipsEnabled - - The MailTipsAllTipsEnabled parameter specifies whether MailTips are enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - MailTipsExternalRecipientsTipsEnabled - - The MailTipsExternalRecipientsTipsEnabled parameter specifies whether MailTips for external recipients are enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - MailTipsGroupMetricsEnabled - - The MailTipsGroupMetricsEnabled parameter specifies whether MailTips that rely on group metrics data are enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - MailTipsLargeAudienceThreshold - - The MailTipsLargeAudienceThreshold parameter specifies what a large audience is. The default value is 25. - - UInt32 - - UInt32 - - - None - - - MailTipsMailboxSourcedTipsEnabled - - The MailTipsMailboxSourcedTipsEnabled parameter specifies whether MailTips that rely on mailbox data (out-of-office or full mailbox) are enabled. - - Boolean - - Boolean - - - None - - - MaskClientIpInReceivedHeadersEnabled - - This parameter is available only in the cloud-based service. - {{ Fill MaskClientIpInReceivedHeadersEnabled Description }} - - Boolean - - Boolean - - - None - - - MatchSenderOrganizerProperties - - This parameter is available only in the cloud-based service. - {{ Fill MatchSenderOrganizerProperties Description }} - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - True - - - 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. This is the default value. - - You can override this setting on individual mailboxes by using the OnlineMeetingsByDefaultEnabled parameter on the Set-MailboxCalendarConfiguration cmdlet. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/outlook-for-ios-and-android-in-the-government-cloud#services-and-features-not-available). - - Boolean - - Boolean - - - None - - - OutlookMobileHelpShiftEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - OutlookMobileSingleAccountEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - PerTenantSwitchToESTSEnabled - - This parameter is available only in the cloud-based service. - This parameter has been deprecated and is no longer used. - - Boolean - - Boolean - - - None - - - PreferredInternetCodePageForShiftJis - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PublicFoldersDeployment - - PublicFoldersDeployment - - - None - - - PublicFolderShowClientControl - - 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. - - Boolean - - Boolean - - - $false - - - ReadTrackingEnabled - - The ReadTrackingEnabled parameter specifies whether the tracking for read status for messages in an organization is enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - RefreshSessionEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RequiredCharsetCoverage - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - SendFromAliasEnabled - - This parameter is available only in the cloud-based service. - {{ Fill SendFromAliasEnabled Description }} - - Boolean - - Boolean - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Boolean - - Boolean - - - None - - - UnblockUnsafeSenderPromptEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WorkspaceTenantEnabled - - This parameter is available only in the cloud-based service. - {{ Fill WorkspaceTenantEnabled Description }} - - Boolean - - Boolean - - - None - - - - Set-OrganizationConfig - - ActivityBasedAuthenticationTimeoutEnabled - - The ActivityBasedAuthenticationTimeoutEnabled parameter specifies whether the timed logoff feature is enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled - - The ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter specifies whether to keep single sign-on enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BookingsSocialSharingRestricted - - This parameter is available only in the cloud-based service. - The BookingsSocialSharingRestricted parameter allows you to control whether, or not, your users can see 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - DefaultPublicFolderMovedItemRetention - - The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant. - When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see Set-PublicFolder (https://docs.microsoft.com/powershell/module/exchange/set-publicfolder). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - DistributionGroupDefaultOU - - The DistributionGroupDefaultOU parameter specifies the container where distribution groups are created by default. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 `"prefix<GroupName>suffix"`. The value `<GroupName>` 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: - - `<City>` - - `<Company>` - - `<CountryCode>` - - `<CountryOrRegion> - - `<CustomAttribute1>` to `<CustomAttribute15>` - - `<Department>` - - `<ExtensionCustomAttribute1>` to `<ExtensionCustomAttribute5>` - - `<Office>` - - `<StateOrProvince>` - - `<Title>` - - For example: `"DL_<StateOrProvince>_<GroupName>"`, `"<StateOrProvince>-<City>-<Office>-<GroupName>"` or `"<GroupName> <CustomAttribute1>"`. - - DistributionGroupNamingPolicy - - DistributionGroupNamingPolicy - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - EwsApplicationAccessPolicy - - EwsApplicationAccessPolicy - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UserContactGroupIdParameter - - UserContactGroupIdParameter - - - None - - - IsAgendaMailEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - MailTipsAllTipsEnabled - - The MailTipsAllTipsEnabled parameter specifies whether MailTips are enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - MailTipsExternalRecipientsTipsEnabled - - The MailTipsExternalRecipientsTipsEnabled parameter specifies whether MailTips for external recipients are enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - MailTipsGroupMetricsEnabled - - The MailTipsGroupMetricsEnabled parameter specifies whether MailTips that rely on group metrics data are enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - MailTipsLargeAudienceThreshold - - The MailTipsLargeAudienceThreshold parameter specifies what a large audience is. The default value is 25. - - UInt32 - - UInt32 - - - None - - - MailTipsMailboxSourcedTipsEnabled - - The MailTipsMailboxSourcedTipsEnabled parameter specifies whether MailTips that rely on mailbox data (out-of-office or full mailbox) are enabled. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - True - - - PreferredInternetCodePageForShiftJis - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PublicFoldersDeployment - - PublicFoldersDeployment - - - None - - - PublicFolderShowClientControl - - 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. - - Boolean - - Boolean - - - $false - - - ReadTrackingEnabled - - The ReadTrackingEnabled parameter specifies whether the tracking for read status for messages in an organization is enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - RefreshSessionEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RequiredCharsetCoverage - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Boolean - - Boolean - - - None - - - UnblockUnsafeSenderPromptEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-OrganizationConfig - - ActivityBasedAuthenticationTimeoutEnabled - - The ActivityBasedAuthenticationTimeoutEnabled parameter specifies whether the timed logoff feature is enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled - - The ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter specifies whether to keep single sign-on enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BookingsSocialSharingRestricted - - This parameter is available only in the cloud-based service. - The BookingsSocialSharingRestricted parameter allows you to control whether, or not, your users can see 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - DefaultPublicFolderMovedItemRetention - - The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant. - When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see Set-PublicFolder (https://docs.microsoft.com/powershell/module/exchange/set-publicfolder). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - DistributionGroupDefaultOU - - The DistributionGroupDefaultOU parameter specifies the container where distribution groups are created by default. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 `"prefix<GroupName>suffix"`. The value `<GroupName>` 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: - - `<City>` - - `<Company>` - - `<CountryCode>` - - `<CountryOrRegion> - - `<CustomAttribute1>` to `<CustomAttribute15>` - - `<Department>` - - `<ExtensionCustomAttribute1>` to `<ExtensionCustomAttribute5>` - - `<Office>` - - `<StateOrProvince>` - - `<Title>` - - For example: `"DL_<StateOrProvince>_<GroupName>"`, `"<StateOrProvince>-<City>-<Office>-<GroupName>"` or `"<GroupName> <CustomAttribute1>"`. - - DistributionGroupNamingPolicy - - DistributionGroupNamingPolicy - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - EwsApplicationAccessPolicy - - EwsApplicationAccessPolicy - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UserContactGroupIdParameter - - UserContactGroupIdParameter - - - None - - - IsAgendaMailEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - MailTipsAllTipsEnabled - - The MailTipsAllTipsEnabled parameter specifies whether MailTips are enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - MailTipsExternalRecipientsTipsEnabled - - The MailTipsExternalRecipientsTipsEnabled parameter specifies whether MailTips for external recipients are enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - MailTipsGroupMetricsEnabled - - The MailTipsGroupMetricsEnabled parameter specifies whether MailTips that rely on group metrics data are enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - MailTipsLargeAudienceThreshold - - The MailTipsLargeAudienceThreshold parameter specifies what a large audience is. The default value is 25. - - UInt32 - - UInt32 - - - None - - - MailTipsMailboxSourcedTipsEnabled - - The MailTipsMailboxSourcedTipsEnabled parameter specifies whether MailTips that rely on mailbox data (out-of-office or full mailbox) are enabled. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - True - - - PreferredInternetCodePageForShiftJis - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PublicFoldersDeployment - - PublicFoldersDeployment - - - None - - - PublicFolderShowClientControl - - 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. - - Boolean - - Boolean - - - $false - - - ReadTrackingEnabled - - The ReadTrackingEnabled parameter specifies whether the tracking for read status for messages in an organization is enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - RefreshSessionEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RequiredCharsetCoverage - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Boolean - - Boolean - - - None - - - UnblockUnsafeSenderPromptEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - ShortenEventScopeDefault - - This parameter is available only in the cloud-based service - {{ Fill ShortenEventScopeDefault Description }} - Valid values are: - - None (default value) - - EndEarly - - StartLate - - ShortenEventScopeMode - - ShortenEventScopeMode - - - None - - - ActivityBasedAuthenticationTimeoutEnabled - - The ActivityBasedAuthenticationTimeoutEnabled parameter specifies whether the timed logoff feature is enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled - - The ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter specifies whether to keep single sign-on enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - AllowPlusAddressInRecipients - - This parameter is available only in the cloud-based service. - The AllowPlusAddressInRecipients parameter enables or disables dynamic, disposable subaddressing as defined in RFC 5233. Valid values are: - - $true: The plus sign in an email address indicates subaddressing. For example, mail sent to jane+exampletag@contoso.com is delivered to jane@contoso.com. For customers who enrolled in Exchange Online after September 2020, this is the default value.- $false: The plus sign in an email address is treated as a literal character. For example, mail sent to jane+exampletag@contoso.com is delivered only if jane+exampletag@contoso.com is configured as the primary address or a proxy address on an existing recipient. For customers who enrolled in Exchange Online before September 2020, this is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - AutoEnableArchiveMailbox - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - BookingsAddressEntryRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsAddressEntryRestricted Description }} - - Boolean - - Boolean - - - None - - - BookingsAuthEnabled - - This parameter is available only in the cloud-based service. - {{ Fill BookingsAuthEnabled Description }} - - Boolean - - Boolean - - - None - - - BookingsCreationOfCustomQuestionsRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsCreationOfCustomQuestionsRestricted Description }} - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BookingsExposureOfStaffDetailsRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsExposureOfStaffDetailsRestricted Description }} - - Boolean - - Boolean - - - None - - - BookingsMembershipApprovalRequired - - This parameter is available only in the cloud-based service. - {{ Fill BookingsMembershipApprovalRequired Description }} - - Boolean - - Boolean - - - None - - - BookingsNotesEntryRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsNotesEntryRestricted Description }} - - Boolean - - Boolean - - - None - - - BookingsPaymentsEnabled - - This parameter is available only in the cloud-based service. - The BookingsPaymentsEnabled parameter specifies whether to enable online payment node inside Bookings. Valid values are: - - $true: Online payments are enabled. - - $false: Online payments are disabled. This is the default value. - - Boolean - - Boolean - - - None - - - BookingsPhoneNumberEntryRestricted - - This parameter is available only in the cloud-based service. - {{ Fill BookingsPhoneNumberEntryRestricted Description }} - - Boolean - - Boolean - - - None - - - BookingsSocialSharingRestricted - - This parameter is available only in the cloud-based service. - The BookingsSocialSharingRestricted parameter allows you to control whether, or not, your users can see 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - CalendarVersionStoreEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - ComplianceMLBgdCrawlEnabled - - This parameter is available only in the cloud-based service. - {{ Fill ComplianceMLBgdCrawlEnabled Description }} - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - CustomerLockboxEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - 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) - - ModernGroupObjectType - - ModernGroupObjectType - - - Private - - - DefaultMinutesToReduceLongEventsBy - - This parameter is available only in the cloud-based service. - {{ Fill DefaultMinutesToReduceLongEventsBy Description }} - - Int32 - - Int32 - - - None - - - DefaultMinutesToReduceShortEventsBy - - This parameter is available only in the cloud-based service. - {{ Fill DefaultMinutesToReduceShortEventsBy Description }} - - Int32 - - Int32 - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - DefaultPublicFolderMovedItemRetention - - The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant. - When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see Set-PublicFolder (https://docs.microsoft.com/powershell/module/exchange/set-publicfolder). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DistributionGroupDefaultOU - - The DistributionGroupDefaultOU parameter specifies the container where distribution groups are created by default. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 `"prefix<GroupName>suffix"`. The value `<GroupName>` 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: - - `<City>` - - `<Company>` - - `<CountryCode>` - - `<CountryOrRegion> - - `<CustomAttribute1>` to `<CustomAttribute15>` - - `<Department>` - - `<ExtensionCustomAttribute1>` to `<ExtensionCustomAttribute5>` - - `<Office>` - - `<StateOrProvince>` - - `<Title>` - - For example: `"DL_<StateOrProvince>_<GroupName>"`, `"<StateOrProvince>-<City>-<Office>-<GroupName>"` or `"<GroupName> <CustomAttribute1>"`. - - DistributionGroupNamingPolicy - - DistributionGroupNamingPolicy - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EnableForwardingAddressSyncForMailboxes - - This parameter is available only in the cloud-based service. - {{ Fill EnableForwardingAddressSyncForMailboxes Description }} - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - EwsApplicationAccessPolicy - - EwsApplicationAccessPolicy - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - For more information about FindTime, see How to create a FindTime poll (https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). - - Boolean - - Boolean - - - None - - - 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. - - For more information about FindTime, see How to create a FindTime poll (https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). - - Boolean - - Boolean - - - None - - - 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. - For more information about FindTime, see How to create a FindTime poll (https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UserContactGroupIdParameter - - UserContactGroupIdParameter - - - None - - - 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, 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - IsAgendaMailEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - MailTipsAllTipsEnabled - - The MailTipsAllTipsEnabled parameter specifies whether MailTips are enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - MailTipsExternalRecipientsTipsEnabled - - The MailTipsExternalRecipientsTipsEnabled parameter specifies whether MailTips for external recipients are enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - MailTipsGroupMetricsEnabled - - The MailTipsGroupMetricsEnabled parameter specifies whether MailTips that rely on group metrics data are enabled. The default value is $true. - - Boolean - - Boolean - - - None - - - MailTipsLargeAudienceThreshold - - The MailTipsLargeAudienceThreshold parameter specifies what a large audience is. The default value is 25. - - UInt32 - - UInt32 - - - None - - - MailTipsMailboxSourcedTipsEnabled - - The MailTipsMailboxSourcedTipsEnabled parameter specifies whether MailTips that rely on mailbox data (out-of-office or full mailbox) are enabled. - - Boolean - - Boolean - - - None - - - MaskClientIpInReceivedHeadersEnabled - - This parameter is available only in the cloud-based service. - {{ Fill MaskClientIpInReceivedHeadersEnabled Description }} - - Boolean - - Boolean - - - None - - - MatchSenderOrganizerProperties - - This parameter is available only in the cloud-based service. - {{ Fill MatchSenderOrganizerProperties Description }} - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - True - - - 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. This is the default value. - - You can override this setting on individual mailboxes by using the OnlineMeetingsByDefaultEnabled parameter on the Set-MailboxCalendarConfiguration cmdlet. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/outlook-for-ios-and-android-in-the-government-cloud#services-and-features-not-available). - - Boolean - - Boolean - - - None - - - OutlookMobileHelpShiftEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - OutlookMobileSingleAccountEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - PerTenantSwitchToESTSEnabled - - This parameter is available only in the cloud-based service. - This parameter has been deprecated and is no longer used. - - Boolean - - Boolean - - - None - - - PreferredInternetCodePageForShiftJis - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PublicFoldersDeployment - - PublicFoldersDeployment - - - None - - - PublicFolderShowClientControl - - 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. - - Boolean - - Boolean - - - $false - - - ReadTrackingEnabled - - The ReadTrackingEnabled parameter specifies whether the tracking for read status for messages in an organization is enabled. The default value is $false. - - Boolean - - Boolean - - - None - - - RefreshSessionEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RequiredCharsetCoverage - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - SendFromAliasEnabled - - This parameter is available only in the cloud-based service. - {{ Fill SendFromAliasEnabled Description }} - - Boolean - - Boolean - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Boolean - - Boolean - - - None - - - UnblockUnsafeSenderPromptEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WorkspaceTenantEnabled - - This parameter is available only in the cloud-based service. - {{ Fill WorkspaceTenantEnabled Description }} - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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,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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-organizationconfig - - - - - - Set-OutlookProtectionRule - Set - OutlookProtectionRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Outlook protection rules are used to automatically rights-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see Outlook protection rules (https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). - Not specifying any conditions results in an Outlook protection rule being applied to all messages. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-OutlookProtectionRule - - Identity - - The Identity parameter specifies the rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - ApplyRightsProtectionTemplate - - The ApplyRightsProtectionTemplate parameter specifies an RMS template to be applied to messages matching the conditions. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - FromDepartment - - The FromDepartment parameter specifies a department name. The rule is applied to messages where the sender's department attribute matches this value. - - String[] - - String[] - - - None - - - Name - - The Name parameter specifies a name for the rule. - - String - - String - - - None - - - Priority - - The Priority parameter specifies a priority for the Outlook protection rule. Rule priority values can range from 0 through n-1, where n is the total number of existing Outlook protection rules. - Any existing rules with priority equal to or higher than the priority being set have their priority incremented by 1. - - Int32 - - Int32 - - - None - - - SentTo - - The SentTo parameter specifies one or more recipients. External recipients can be specified using the SMTP address. - Internal recipients can be specified using any of the following values: - - Alias - - Distinguished name (DN) - - ExchangeGUID - - LegacyExchangeDN - - SmtpAddress - - User principal name (UPN) - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SentToScope - - 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. - - ToUserScope - - ToUserScope - - - None - - - UserCanOverride - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - ApplyRightsProtectionTemplate - - The ApplyRightsProtectionTemplate parameter specifies an RMS template to be applied to messages matching the conditions. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - FromDepartment - - The FromDepartment parameter specifies a department name. The rule is applied to messages where the sender's department attribute matches this value. - - String[] - - String[] - - - None - - - Name - - The Name parameter specifies a name for the rule. - - String - - String - - - None - - - Priority - - The Priority parameter specifies a priority for the Outlook protection rule. Rule priority values can range from 0 through n-1, where n is the total number of existing Outlook protection rules. - Any existing rules with priority equal to or higher than the priority being set have their priority incremented by 1. - - Int32 - - Int32 - - - None - - - SentTo - - The SentTo parameter specifies one or more recipients. External recipients can be specified using the SMTP address. - Internal recipients can be specified using any of the following values: - - Alias - - Distinguished name (DN) - - ExchangeGUID - - LegacyExchangeDN - - SmtpAddress - - User principal name (UPN) - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SentToScope - - 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. - - ToUserScope - - ToUserScope - - - None - - - UserCanOverride - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Set-OutlookProtectionRule -Identity "OPR-DG-Finance" -Priority 2 - - This example sets the priority of the Outlook protection rule OPR-DG-Finance to 2. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-outlookprotectionrule - - - - - - Set-RemoteDomain - Set - RemoteDomain - - This cmdlet is available in 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-RemoteDomain cmdlet to configure a managed connection for a remote domain. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When you set a remote domain, you can control mail flow with more precision, specify message formatting and policy and specify acceptable character sets for messages sent to or received from the remote domain. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-RemoteDomain - - Identity - - 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 - - RemoteDomainIdParameter - - RemoteDomainIdParameter - - - None - - - AllowedOOFType - - 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. - - AllowedOOFType - - AllowedOOFType - - - None - - - AutoForwardEnabled - - 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. - - Boolean - - Boolean - - - None - - - AutoReplyEnabled - - 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. - - Boolean - - Boolean - - - None - - - ByteEncoderTypeFor7BitCharsets - - 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. - - ByteEncoderTypeFor7BitCharsetsEnum - - ByteEncoderTypeFor7BitCharsetsEnum - - - None - - - CharacterSet - - The CharacterSet parameter specifies a character set for MIME messages without defined character sets that are sent from your organization to recipients in the remote domain. Valid values are: - big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874, or the value $null. - The default value for the built-in remote domain named Default is iso-8859-1. The default value for new remote domains that you create is blank ($null). - This setting doesn't overwrite character sets that are already specified in outbound MIME messages. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ContentType - - 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. - - ContentType - - ContentType - - - None - - - DeliveryReportEnabled - - 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. - - Boolean - - Boolean - - - None - - - DisplaySenderName - - Note : You should only modify this parameter under the direction of Microsoft Customer Service and Support. - The DisplaySenderName parameter specifies whether to show the sender's Display Name in the From email address for messages sent to recipients in the remote domain. Valid values are: - - $true: Sender names are displayed in messages sent to recipients in the remote domain. This is the default value. - - $false. Sender names aren't displayed in messages sent to recipients in the remote domain. - - Boolean - - Boolean - - - None - - - 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. - - $false: Recipients in the remote domain are treated as external recipients. This is the default value. - - Boolean - - Boolean - - - None - - - LineWrapSize - - The LineWrapSize parameter specifies the line-wrap size for messages to recipients in the remote domain. Valid values are an integer from 0 through 132 or the value to unlimited. The default value is unlimited. - - Unlimited - - Unlimited - - - None - - - MeetingForwardNotificationEnabled - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - NonMimeCharacterSet - - The NonMimeCharacterSet parameter specifies a character set for plain text messages without defined character sets that are sent from your organization to recipients in the remote domain. Valid values are: - big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874, or the value $null. - The default value for the built-in remote domain named Default is iso-8859-1. The default value for new remote domains that you create is blank ($null). - This setting doesn't overwrite character sets that are already specified in outbound plain text messages. - - String - - String - - - None - - - PreferredInternetCodePageForShiftJis - - 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. - - PreferredInternetCodePageForShiftJisEnum - - PreferredInternetCodePageForShiftJisEnum - - - None - - - 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. - 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. - - Int32 - - Int32 - - - None - - - TargetDeliveryDomain - - The TargetDeliveryDomain parameter specifies whether the remote domain is used in cross-forest deployments to generate target email addresses for new mail users that represent users in the other organization (for example, all mailboxes hosted on Exchange Online are represented as mail users in your on-premises organization). Valid values are: - - $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. - - Boolean - - Boolean - - - None - - - 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: - - $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 - - Boolean - - Boolean - - - None - - - 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 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. - - Boolean - - Boolean - - - None - - - TrustedMailOutboundEnabled - - 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. - - Boolean - - Boolean - - - None - - - 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>`. - - $false: Simple display names aren't used in messages sent to recipients in the remote domain. This is the default value. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - RemoteDomainIdParameter - - RemoteDomainIdParameter - - - None - - - AllowedOOFType - - 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. - - AllowedOOFType - - AllowedOOFType - - - None - - - AutoForwardEnabled - - 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. - - Boolean - - Boolean - - - None - - - AutoReplyEnabled - - 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. - - Boolean - - Boolean - - - None - - - ByteEncoderTypeFor7BitCharsets - - 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. - - ByteEncoderTypeFor7BitCharsetsEnum - - ByteEncoderTypeFor7BitCharsetsEnum - - - None - - - CharacterSet - - The CharacterSet parameter specifies a character set for MIME messages without defined character sets that are sent from your organization to recipients in the remote domain. Valid values are: - big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874, or the value $null. - The default value for the built-in remote domain named Default is iso-8859-1. The default value for new remote domains that you create is blank ($null). - This setting doesn't overwrite character sets that are already specified in outbound MIME messages. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ContentType - - 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. - - ContentType - - ContentType - - - None - - - DeliveryReportEnabled - - 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. - - Boolean - - Boolean - - - None - - - DisplaySenderName - - Note : You should only modify this parameter under the direction of Microsoft Customer Service and Support. - The DisplaySenderName parameter specifies whether to show the sender's Display Name in the From email address for messages sent to recipients in the remote domain. Valid values are: - - $true: Sender names are displayed in messages sent to recipients in the remote domain. This is the default value. - - $false. Sender names aren't displayed in messages sent to recipients in the remote domain. - - Boolean - - Boolean - - - None - - - 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. - - $false: Recipients in the remote domain are treated as external recipients. This is the default value. - - Boolean - - Boolean - - - None - - - LineWrapSize - - The LineWrapSize parameter specifies the line-wrap size for messages to recipients in the remote domain. Valid values are an integer from 0 through 132 or the value to unlimited. The default value is unlimited. - - Unlimited - - Unlimited - - - None - - - MeetingForwardNotificationEnabled - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - NonMimeCharacterSet - - The NonMimeCharacterSet parameter specifies a character set for plain text messages without defined character sets that are sent from your organization to recipients in the remote domain. Valid values are: - big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874, or the value $null. - The default value for the built-in remote domain named Default is iso-8859-1. The default value for new remote domains that you create is blank ($null). - This setting doesn't overwrite character sets that are already specified in outbound plain text messages. - - String - - String - - - None - - - PreferredInternetCodePageForShiftJis - - 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. - - PreferredInternetCodePageForShiftJisEnum - - PreferredInternetCodePageForShiftJisEnum - - - None - - - 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. - 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. - - Int32 - - Int32 - - - None - - - TargetDeliveryDomain - - The TargetDeliveryDomain parameter specifies whether the remote domain is used in cross-forest deployments to generate target email addresses for new mail users that represent users in the other organization (for example, all mailboxes hosted on Exchange Online are represented as mail users in your on-premises organization). Valid values are: - - $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. - - Boolean - - Boolean - - - None - - - 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: - - $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 - - Boolean - - Boolean - - - None - - - 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 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. - - Boolean - - Boolean - - - None - - - TrustedMailOutboundEnabled - - 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. - - Boolean - - Boolean - - - None - - - 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>`. - - $false: Simple display names aren't used in messages sent to recipients in the remote domain. This is the default value. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 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 -------------------------- - Get-RemoteDomain | Where {$_.AutoReplyEnabled -eq $false} | Set-RemoteDomain -AutoForwardEnabled $false -NDREnabled $false - - This example queries Active Directory for all remote domains for which auto replies are disabled. Using the pipelining feature, it also disables auto forwards and NDRs to those domains. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-remotedomain - - - - - - Set-RMSTemplate - Set - RMSTemplate - - This cmdlet is available only in the cloud-based service. - Use the Set-RMSTemplate cmdlet to modify the properties of an existing Rights Management Services (RMS) template in your organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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). - - - - Set-RMSTemplate - - 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. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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. - - RmsTemplateType - - RmsTemplateType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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. - - RmsTemplateType - - RmsTemplateType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-rmstemplate - - - - - - Set-RMSTrustedPublishingDomain - Set - RMSTrustedPublishingDomain - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A TPD contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages. - - - - Set-RMSTrustedPublishingDomain - - Identity - - The Identity parameter specifies the TPD. You can use any value that uniquely identifies the TPD, for example: - - Name - - Distinguished name (DN) - - GUID - - RmsTrustedPublishingDomainIdParameter - - RmsTrustedPublishingDomainIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - Name - - The Name parameter specifies the name of the TPD. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the TPD. You can use any value that uniquely identifies the TPD, for example: - - Name - - Distinguished name (DN) - - GUID - - RmsTrustedPublishingDomainIdParameter - - RmsTrustedPublishingDomainIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Uri - - Uri - - - None - - - Name - - The Name parameter specifies the name of the TPD. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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`. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-rmstrustedpublishingdomain - - - - - - Set-TransportConfig - Set - TransportConfig - - This cmdlet is available in 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-TransportConfig cmdlet to modify the transport configuration settings for the whole Exchange organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-TransportConfig - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - AddressBookPolicyRoutingEnabled - - The AddressBookPolicyRoutingEnabled parameter controls how recipients are resolved in an organization that uses address book policies to create separate virtual organizations within the same Exchange organization. Specifically, the global address list (GAL) that's specified in the user's address book policy controls how recipients are resolved. When the value of this parameter is $true, users that are assigned different GALs appear as external recipients. When the value of this parameter is $false, users that are assigned different GALs appear as internal recipients. - The default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see Address book policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - Boolean - - Boolean - - - None - - - ClearCategories - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ConvertDisclaimerWrapperToEml - - The ConvertDisclaimerWrapperToEml parameter specifies whether the original message will be added as a TNEF attachment or a regular EML attachment to a disclaimer when all of the following are true: - - 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. - 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. - - Boolean - - Boolean - - - None - - - 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: - - 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. - - 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. - - DSNConversionOption - - DSNConversionOption - - - None - - - ExternalDelayDsnEnabled - - 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. - - Boolean - - Boolean - - - None - - - ExternalDsnDefaultLanguage - - The ExternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create external DSN messages. The default value is the default Windows server language. - - CultureInfo - - CultureInfo - - - None - - - ExternalDsnLanguageDetectionEnabled - - 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. - - Boolean - - Boolean - - - None - - - ExternalDsnReportingAuthority - - 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. - - SmtpDomain - - SmtpDomain - - - None - - - ExternalDsnSendHtml - - The ExternalDsnSendHtml parameter specifies whether external DSN messages should be HTML or plain text. Valid values are: - - $true: DSNs are HTML. This is the default value. - - $false: DSNs are plain text. - - Boolean - - Boolean - - - None - - - ExternalPostmasterAddress - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - - SwitchParameter - - - False - - - HeaderPromotionModeSetting - - The HeaderPromotionModeSetting parameter specifies whether named properties are created for custom X-headers on messages received from outside the Exchange organization. Valid values are: - - MustCreate: Exchange creates a named property for each new custom X-header. - - MayCreate: Exchange creates a named property for each new custom X-header on messages received from authenticated senders. No named properties are created for custom X-headers on messages received from unauthenticated senders. - - NoCreate: Exchange won't create any named properties based on custom X-headers on incoming messages. This is the default value. - - HeaderPromotionMode - - HeaderPromotionMode - - - None - - - InternalDelayDsnEnabled - - 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. - - Boolean - - Boolean - - - None - - - InternalDsnDefaultLanguage - - The InternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create internal DSN messages. The default value is the default Windows server language. - - CultureInfo - - CultureInfo - - - None - - - InternalDsnLanguageDetectionEnabled - - 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. - - Boolean - - Boolean - - - None - - - InternalDsnReportingAuthority - - 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. - - SmtpDomain - - SmtpDomain - - - None - - - InternalDsnSendHtml - - The InternalDsnSendHtml parameter specifies whether internal DSN messages should be HTML or plain text. Valid values are: - - $true: DSNs are HTML. This is the default value. - - $false: DSNs are plain text. - - Boolean - - Boolean - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - MaxRecipientEnvelopeLimit - - 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. - In Exchange Online, the default value is Unlimited, which means the organizational limit of 1000 is used. You can enter a custom value up to 1000. For more information, see Sending limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1)in the Microsoft 365 service description. - - Unlimited - - Unlimited - - - None - - - Rfc2231EncodingEnabled - - 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. - - Boolean - - Boolean - - - None - - - SmtpClientAuthenticationDisabled - - 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. 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). - - Boolean - - Boolean - - - None - - - VoicemailJournalingEnabled - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - AddressBookPolicyRoutingEnabled - - The AddressBookPolicyRoutingEnabled parameter controls how recipients are resolved in an organization that uses address book policies to create separate virtual organizations within the same Exchange organization. Specifically, the global address list (GAL) that's specified in the user's address book policy controls how recipients are resolved. When the value of this parameter is $true, users that are assigned different GALs appear as external recipients. When the value of this parameter is $false, users that are assigned different GALs appear as internal recipients. - The default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see Address book policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - Boolean - - Boolean - - - None - - - ClearCategories - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ConvertDisclaimerWrapperToEml - - The ConvertDisclaimerWrapperToEml parameter specifies whether the original message will be added as a TNEF attachment or a regular EML attachment to a disclaimer when all of the following are true: - - 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. - 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. - - Boolean - - Boolean - - - None - - - 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: - - 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. - - 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. - - DSNConversionOption - - DSNConversionOption - - - None - - - ExternalDelayDsnEnabled - - 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. - - Boolean - - Boolean - - - None - - - ExternalDsnDefaultLanguage - - The ExternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create external DSN messages. The default value is the default Windows server language. - - CultureInfo - - CultureInfo - - - None - - - ExternalDsnLanguageDetectionEnabled - - 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. - - Boolean - - Boolean - - - None - - - ExternalDsnReportingAuthority - - 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. - - SmtpDomain - - SmtpDomain - - - None - - - ExternalDsnSendHtml - - The ExternalDsnSendHtml parameter specifies whether external DSN messages should be HTML or plain text. Valid values are: - - $true: DSNs are HTML. This is the default value. - - $false: DSNs are plain text. - - Boolean - - Boolean - - - None - - - ExternalPostmasterAddress - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - HeaderPromotionModeSetting - - The HeaderPromotionModeSetting parameter specifies whether named properties are created for custom X-headers on messages received from outside the Exchange organization. Valid values are: - - MustCreate: Exchange creates a named property for each new custom X-header. - - MayCreate: Exchange creates a named property for each new custom X-header on messages received from authenticated senders. No named properties are created for custom X-headers on messages received from unauthenticated senders. - - NoCreate: Exchange won't create any named properties based on custom X-headers on incoming messages. This is the default value. - - HeaderPromotionMode - - HeaderPromotionMode - - - None - - - InternalDelayDsnEnabled - - 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. - - Boolean - - Boolean - - - None - - - InternalDsnDefaultLanguage - - The InternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create internal DSN messages. The default value is the default Windows server language. - - CultureInfo - - CultureInfo - - - None - - - InternalDsnLanguageDetectionEnabled - - 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. - - Boolean - - Boolean - - - None - - - InternalDsnReportingAuthority - - 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. - - SmtpDomain - - SmtpDomain - - - None - - - InternalDsnSendHtml - - The InternalDsnSendHtml parameter specifies whether internal DSN messages should be HTML or plain text. Valid values are: - - $true: DSNs are HTML. This is the default value. - - $false: DSNs are plain text. - - Boolean - - Boolean - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - MaxRecipientEnvelopeLimit - - 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. - In Exchange Online, the default value is Unlimited, which means the organizational limit of 1000 is used. You can enter a custom value up to 1000. For more information, see Sending limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1)in the Microsoft 365 service description. - - Unlimited - - Unlimited - - - None - - - Rfc2231EncodingEnabled - - 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. - - Boolean - - Boolean - - - None - - - SmtpClientAuthenticationDisabled - - 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. 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). - - Boolean - - Boolean - - - None - - - VoicemailJournalingEnabled - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Set-TransportConfig -JournalingReportNdrTo journalingndr@contoso.com - - This example configures the Exchange organization to redirect all journaling reports that can't be delivered to the journaling mailbox to the email account journalingndr@contoso.com. - To avoid journaling issues, we recommend that you set JournalingReportNdrTo to a dedicated mailbox without any transport rule or mailbox rule. Or, set JournalingReportNdrTo to an external address. In Exchange Online, you can configure this setting by using the Microsoft 365 admin center or Exchange Online PowerShell. In on-premises Exchange Server, you can configure this setting by using the Exchange Management Shell. For more information, see KB2829319 (https://support.microsoft.com/help/2829319). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-transportconfig - - - - - - Test-DataClassification - Test - DataClassification - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet lets you know the classification results that are returned by the Microsoft classification engine in specific text. The classification results include the sensitive type, its count, and confidence. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-DataClassification - - 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. - - String[] - - String[] - - - None - - - DomainController - - This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - TestTextExtractionResults - - The TestTextExtractionResults parameter specifies the extracted text from the Test-TextExtraction cmdlet as the input text stream. - - TestTextExtractionResult[] - - TestTextExtractionResult[] - - - None - - - TextToClassify - - The TextToClassify parameter specifies the text string for which classification results need to be shown. - - String - - String - - - None - - - - - - 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. - - String[] - - String[] - - - None - - - DomainController - - This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - TestTextExtractionResults - - The TestTextExtractionResults parameter specifies the extracted text from the Test-TextExtraction cmdlet as the input text stream. - - TestTextExtractionResult[] - - TestTextExtractionResult[] - - - None - - - TextToClassify - - The TextToClassify parameter specifies the text string for which classification results need to be shown. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - $r = Test-DataClassification -TextToClassify "Credit card information Visa: 4485 3647 3952 7352. Patient Identifier or SSN: 452-12-1232" -$r.ClassificationResults - - This example lists all sensitive info types, their count, and confidence in the specified text string. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-dataclassification - - - - - - Test-OAuthConnectivity - Test - OAuthConnectivity - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-OAuthConnectivity - - Service - - The Service parameter specifies the partner application. Valid values for this parameter are: - - EWS - - AutoD - - Generic - - ModServiceType - - ModServiceType - - - None - - - TargetUri - - The TargetUri parameter specifies the URL for the service you want to test OAuth connectivity with. - - Uri - - Uri - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - OrganizationDomain - - This parameter is available only in the cloud-based service. - The OrganizationDomain parameter specifies the domain name of the Microsoft 365 organization. For example, contoso.com. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Service - - The Service parameter specifies the partner application. Valid values for this parameter are: - - EWS - - AutoD - - Generic - - ModServiceType - - ModServiceType - - - None - - - TargetUri - - The TargetUri parameter specifies the URL for the service you want to test OAuth connectivity with. - - Uri - - Uri - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - OrganizationDomain - - This parameter is available only in the cloud-based service. - The OrganizationDomain parameter specifies the domain name of the Microsoft 365 organization. For example, contoso.com. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-oauthconnectivity - - - - - - Test-TextExtraction - Test - TextExtraction - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Test-TextExtraction cmdlet to find the text that is extracted from a specified email message in Exchange flow. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet returns the text that is found in a file in Exchange. The Microsoft classification engine uses this text to classify content and determine which sensitive information types are found in this file/message. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-TextExtraction - - 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 Get-Content cmdlet. For example, `(Get-Content -Encoding Byte -Path "C:\My Documents<filename>" -ReadCount 0)`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 Get-Content cmdlet. For example, `(Get-Content -Encoding Byte -Path "C:\My Documents<filename>" -ReadCount 0)`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - $content = Test-TextExtraction -FileData (Get-Content -Path '.\finalcial data.msg' -Encoding byte -ReadCount 0) -$content.ExtractedResults - - This example returns the text that's extracted from the email "financial data.msg" - - - - -------------------------- Example 2 -------------------------- - $content = Test-TextExtraction -FileData (Get-Content -Path '.\finalcial data.msg' -Encoding byte -ReadCount 0) -Test-DataClassification -TestTextExtractionResults $tr.ExtractedResults - - This example extracts the text from the email "financial data.msg" and returns the sensitive information types, their confidence, and count. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-textextraction - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.RolesAndAccess-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.RolesAndAccess-Help.xml deleted file mode 100644 index 7280fb64c939..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.RolesAndAccess-Help.xml +++ /dev/null @@ -1,77386 +0,0 @@ - - - - - Add-MailboxPermission - Add - MailboxPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Add-MailboxPermission - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MailboxRights[] - - MailboxRights[] - - - None - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - $true - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - InheritanceType - - The InheritanceType parameter specifies how permissions are inherited by folders in the mailbox. Valid values are: - - All - - Children - - Descendents[sic] - - SelfAndChildren - - ActiveDirectorySecurityInheritance - - ActiveDirectorySecurityInheritance - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Add-MailboxPermission - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Add-MailboxPermission - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MailboxRights[] - - MailboxRights[] - - - None - - - Instance - - This parameter has been deprecated and is no longer used. - - MailboxAcePresentationObject - - MailboxAcePresentationObject - - - None - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - $true - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - InheritanceType - - The InheritanceType parameter specifies how permissions are inherited by folders in the mailbox. Valid values are: - - All - - Children - - Descendents[sic] - - SelfAndChildren - - ActiveDirectorySecurityInheritance - - ActiveDirectorySecurityInheritance - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MailboxRights[] - - MailboxRights[] - - - None - - - Instance - - This parameter has been deprecated and is no longer used. - - MailboxAcePresentationObject - - MailboxAcePresentationObject - - - None - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - $true - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - InheritanceType - - The InheritanceType parameter specifies how permissions are inherited by folders in the mailbox. Valid values are: - - All - - Children - - Descendents[sic] - - SelfAndChildren - - ActiveDirectorySecurityInheritance - - ActiveDirectorySecurityInheritance - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 Exchange Online, this example assigns the administrator account admin@contoso.com Full Access permission to all user mailboxes in the contoso.com organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-mailboxpermission - - - - - - Add-ManagementRoleEntry - Add - ManagementRoleEntry - - This cmdlet is available in 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-ManagementRoleEntry cmdlet to add management role entries to an existing management role. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The cmdlet and its parameters that you add to a role entry must exist in the parent role. You can't add role entries to built-in roles. - You can only add a role entry to a management role if the role entry exists in the role's parent role. For example, if you try to add the Search-Mailbox role entry to a role that's a child of the Mail Recipients role, you'll receive an error. This error occurs because the Search-Mailbox role entry doesn't exist in the Mail Recipients role. To add the Search-Mailbox role entry to a role, you need to create a role that's a child of the Mailbox Import Export role, which contains the Search-Mailbox role entry. Then you can use the Add-ManagementRoleEntry cmdlet to add the Search-Mailbox role entry to the new child role. - For more information about management role entries, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Add-ManagementRoleEntry - - Identity - - The Identity parameter specifies the role entry that you want to add. This parameter uses the syntax: `Management role\role entry name` (for example, `CustomRole\Set-Mailbox`). - For more information about how management role entries work, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - 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 ("). - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Overwrite - - The Overwrite parameter causes existing role entries to be overwritten by the role entries being added. - - - SwitchParameter - - - False - - - Parameters - - The Parameters parameter specifies the parameters to be included in the role being added. The parameters specified must exist on the cmdlet associated with the role entry. You can specify multiple parameters, separated with commas. - - String[] - - String[] - - - None - - - Type - - The Type parameter specifies the type of role entry being added. The valid values are Cmdlet, Script and ApplicationPermission. - - ManagementRoleEntryType - - ManagementRoleEntryType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Add-ManagementRoleEntry - - ParentRoleEntry - - The ParentRoleEntry parameter specifies the role entry in the parent role to add to the role specified with the Role parameter. This parameter generally isn't used directly, but exists to enable the piping of role entries from the Get-ManagementRoleEntry cmdlet. If you use the ParentRoleEntry parameter, you can't use the UnScopedTopLevel switch. - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - Role - - The Role parameter specifies the role to which the new role entry, specified by the ParentRoleEntry parameter, is added. - - RoleIdParameter - - RoleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Overwrite - - The Overwrite parameter causes existing role entries to be overwritten by the role entries being added. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the role entry that you want to add. This parameter uses the syntax: `Management role\role entry name` (for example, `CustomRole\Set-Mailbox`). - For more information about how management role entries work, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - 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 ("). - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - ParentRoleEntry - - The ParentRoleEntry parameter specifies the role entry in the parent role to add to the role specified with the Role parameter. This parameter generally isn't used directly, but exists to enable the piping of role entries from the Get-ManagementRoleEntry cmdlet. If you use the ParentRoleEntry parameter, you can't use the UnScopedTopLevel switch. - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - Role - - The Role parameter specifies the role to which the new role entry, specified by the ParentRoleEntry parameter, is added. - - RoleIdParameter - - RoleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Overwrite - - The Overwrite parameter causes existing role entries to be overwritten by the role entries being added. - - SwitchParameter - - SwitchParameter - - - False - - - Parameters - - The Parameters parameter specifies the parameters to be included in the role being added. The parameters specified must exist on the cmdlet associated with the role entry. You can specify multiple parameters, separated with commas. - - String[] - - String[] - - - None - - - Type - - The Type parameter specifies the type of role entry being added. The valid values are Cmdlet, Script and ApplicationPermission. - - ManagementRoleEntryType - - ManagementRoleEntryType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - Add-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters "Department","Location" -UnScopedTopLevel - - In on-premises Exchange, this example adds the MailboxAudit script with the Department and Location parameters to 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-managementroleentry - - - - - - Add-RoleGroupMember - Add - RoleGroupMember - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Add-RoleGroupMember - - 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 ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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 ("). - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - 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 ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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 ("). - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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: - - About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines)- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-rolegroupmember - - - - - - Add-UnifiedGroupLinks - Add - UnifiedGroupLinks - - 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 : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Microsoft 365 Groups are group objects that are available across Microsoft 365 services. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). Note : Only members can be owners of a group, so you must first add a user as member before adding it as an owner. - - - - Add-UnifiedGroupLinks - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - LinkType - - The LinkType parameter specifies the Microsoft 365 Group property that you want to modify. Valid values are: - - Aggregators - - Members - - Owners - - Subscribers - - LinkType - - LinkType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - LinkType - - The LinkType parameter specifies the Microsoft 365 Group property that you want to modify. Valid values are: - - Aggregators - - Members - - Owners - - Subscribers - - LinkType - - LinkType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 Microsoft 365 Group named Legal Department. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-unifiedgrouplinks - - - - - - Disable-JournalArchiving - Disable - JournalArchiving - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-JournalArchiving - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-journalarchiving - - - - - - Disable-Mailbox - Disable - Mailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-Mailbox - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-mailbox - - - - - - Enable-Mailbox - Enable - Mailbox - - This cmdlet is available in 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 Azure AD account, you need to add a license to the account as described in Assign licenses to user accounts (https://docs.microsoft.com/office365/enterprise/powershell/assign-licenses-to-user-accounts-with-office-365-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-Mailbox - - 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 - - UserIdParameter - - UserIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Enable-Mailbox - - 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 - - UserIdParameter - - UserIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - UserIdParameter - - UserIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 username 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-mailbox - - - - - - Get-AccessToCustomerDataRequest - Get - AccessToCustomerDataRequest - - This cmdlet is available only in the cloud-based service. - Use the Get-AccessToCustomerDataRequest cmdlet to view Microsoft 365 customer lockbox requests that control access to your data by Microsoft support engineers. Note : Customer lockbox is included in the Microsoft 365 E5 plan. If you don't have a Microsoft 365 E5 plan, you can buy a separate customer lockbox subscription with any Microsoft 365 Enterprise plan. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AccessToCustomerDataRequest - - ApprovalStatus - - The ApprovalStatus parameter filters the results by approval status. Valid values are: - - Approved - - Canceled - - Denied - - Pending - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - ExDateTime - - ExDateTime - - - None - - - RequestId - - The RequestId parameter filters the results by reference number (for example, EXSR123456). - - String - - String - - - None - - - - - - ApprovalStatus - - The ApprovalStatus parameter filters the results by approval status. Valid values are: - - Approved - - Canceled - - Denied - - Pending - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - ExDateTime - - ExDateTime - - - None - - - RequestId - - The RequestId parameter filters the results by reference number (for example, EXSR123456). - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-accesstocustomerdatarequest - - - - - - Get-AddressBookPolicy - Get - AddressBookPolicy - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AddressBookPolicy - - Identity - - The Identity parameter specifies the identity of the address book policy. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the identity of the address book policy. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-addressbookpolicy - - - - - - Get-AddressList - Get - AddressList - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can pipe the output from the Get-AddressList cmdlet to the Remove-AddressList, Set-AddressList, Update-AddressList and Move-AddressList cmdlets instead of using the Identity parameter with each of those cmdlets. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AddressList - - 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. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - - Get-AddressList - - 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. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - - Get-AddressList - - 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. - - String - - String - - - None - - - - - - 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. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - 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. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - 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. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-addresslist - - - - - - Get-AdministrativeUnit - Get - AdministrativeUnit - - This cmdlet is available or functional only in the cloud-based service. - Use the Get-AdministrativeUnit cmdlet to view administrative units, which are Azure Active Directory containers of resources. You can use administrative units to delegate administrative permissions and apply policies to different groups of users. Note : Administrative units are only available in Azure Active Directory Premium. You create and manage administrative units in Azure AD PowerShell. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AdministrativeUnit - - 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) - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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) - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-administrativeunit - - - - - - Get-AuthenticationPolicy - Get - AuthenticationPolicy - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Get-AuthenticationPolicy cmdlet to view authentication policies in your organization. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AuthenticationPolicy - - 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 - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - - - - 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 - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-authenticationpolicy - - - - - - Get-AuthServer - Get - AuthServer - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - An authorization server is a server or service that issues tokens trusted by Microsoft Exchange for access by partner applications. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AuthServer - - 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 - - AuthServerIdParameter - - AuthServerIdParameter - - - None - - - - - - 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 - - AuthServerIdParameter - - AuthServerIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AuthServer - - This example returns a summary list of all authorization servers in the Exchange organization. - - - - -------------------------- Example 2 -------------------------- - Get-AuthServer -Identity WindowsAzureAC | Format-List - - This example retrieves detailed information for the authorization server named WindowsAzureAC. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-authserver - - - - - - Get-Contact - Get - Contact - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-Contact cmdlet returns no mail-related properties for mail contacts. Use the Get-MailContact to view mail-related properties for mail contacts. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-Contact - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-Contact - - 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 - - ContactIdParameter - - ContactIdParameter - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - ContactIdParameter - - ContactIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-contact - - - - - - Get-EmailAddressPolicy - Get - EmailAddressPolicy - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Get-EmailAddressPolicy cmdlet to view email address policies. In Exchange Online, email address policies are only available for Microsoft 365 Groups. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-EmailAddressPolicy - - 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 - - EmailAddressPolicyIdParameter - - EmailAddressPolicyIdParameter - - - None - - - - - - 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 - - EmailAddressPolicyIdParameter - - EmailAddressPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-emailaddresspolicy - - - - - - Get-EventsFromEmailConfiguration - Get - EventsFromEmailConfiguration - - This cmdlet is only available in the cloud-based service. - Use the Get-EventsFromEmailConfiguration cmdlet to view the events from email settings on a mailbox. These settings define whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to the user's calendar. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Note : The following output properties have been deprecated: EventReservationProcessingLevel, FoodEstablishmentReservationProcessingLevel, InvoiceProcessingLevel, and ServiceReservationProcessingLevel. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-EventsFromEmailConfiguration - - Identity - - The Identity parameter specifies the mailbox that you want to view. You identify the mailbox by email address. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the mailbox that you want to view. You identify the mailbox by email address. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-EventsFromEmailConfiguration -Identity peter@contoso.com - - This example retrieves all events from email settings for peter@contoso.com's mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-eventsfromemailconfiguration - - - - - - Get-GlobalAddressList - Get - GlobalAddressList - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-GlobalAddressList cmdlet is mainly used to populate the GAL property pages in the Exchange admin center. This command doesn't provide a filtering capability. If filtering is required, you should use a WHERE clause with the command. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-GlobalAddressList - - 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. - - - SwitchParameter - - - False - - - - Get-GlobalAddressList - - 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 - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-globaladdresslist - - - - - - Get-LinkedUser - Get - LinkedUser - - This cmdlet is available only in the cloud-based service. - Use the Get-LinkedUser cmdlet to view existing linked user accounts. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-LinkedUser - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - OrganizationalUnit - - This parameter is reserved for internal Microsoft use. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-LinkedUser - - 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 - - UserIdParameter - - UserIdParameter - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - OrganizationalUnit - - This parameter is reserved for internal Microsoft use. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - UserIdParameter - - UserIdParameter - - - None - - - OrganizationalUnit - - This parameter is reserved for internal Microsoft use. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-linkeduser - - - - - - Get-Mailbox - Get - Mailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When you use the Get-Mailbox cmdlet in on-premises Exchange environments to view the quota settings for a mailbox, you first need to check the value of the UseDatabaseQuotaDefaults property. The value True means per-mailbox quota settings are ignored, and you need to use the Get-MailboxDatabase cmdlet to see the actual values. If the UseDatabaseQuotaDefaults property is False, the per-mailbox quota settings are used, so what you see with the Get-Mailbox cmdlet are the actual quota values for the mailbox. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-Mailbox - - 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 - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Migration - - The Migration switch is required to return migration mailboxes in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - - SwitchParameter - - - 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 - - String - - String - - - None - - - - Get-Mailbox - - 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. - - - SwitchParameter - - - False - - - Async - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Migration - - The Migration switch is required to return migration mailboxes in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - - SwitchParameter - - - 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 - - String - - String - - - None - - - - Get-Mailbox - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Migration - - The Migration switch is required to return migration mailboxes in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - - SwitchParameter - - - 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 - - String - - String - - - None - - - - Get-Mailbox - - 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. - - - SwitchParameter - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - Migration - - The Migration switch is required to return migration mailboxes in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - - SwitchParameter - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Async - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Identity - - The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - You can't use this parameter with the Anr, Database, MailboxPlan or Server parameters. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - Migration - - The Migration switch is required to return migration mailboxes in the results. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailbox - - - - - - Get-MailboxAutoReplyConfiguration - Get - MailboxAutoReplyConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxAutoReplyConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-Mailbox -ResultSize unlimited | 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxautoreplyconfiguration - - - - - - Get-MailboxCalendarConfiguration - Get - MailboxCalendarConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxCalendarConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxcalendarconfiguration - - - - - - Get-MailboxFolder - Get - MailboxFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This command checks that the mailbox specified in the Identity parameter is a valid Exchange mailbox before retrieving the requested folders. The cmdlet returns all folders if the MailFolderOnly switch isn't specified. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-MailboxFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MailboxFolder -Identity :\Inbox | Format List - - This example returns detailed information about the Inbox folder in your own mailbox. - - - - -------------------------- Example 2 -------------------------- - Get-MailboxFolder - - This example returns a summary list of the root folders in your own mailbox. - - - - -------------------------- Example 3 -------------------------- - Get-MailboxFolder -GetChildren -MailFolderOnly - - This example returns the first level of mail folders in your own mailbox. - - - - -------------------------- Example 4 -------------------------- - Get-MailboxFolder -Identity :\Inbox -GetChildren - - This example returns information about all the subfolders under Inbox in your own mailbox. - - - - -------------------------- Example 5 -------------------------- - Get-MailboxFolder -Identity :\Inbox -Recurse - - This example returns a summary list of all levels of folders under Inbox in your own mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolder - - - - - - Get-MailboxJunkEmailConfiguration - Get - MailboxJunkEmailConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-antispam-settings). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxJunkEmailConfiguration - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxjunkemailconfiguration - - - - - - Get-MailboxLocation - Get - MailboxLocation - - This cmdlet is available in 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxLocation - - 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 <MailboxIdentity> | 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. - - MailboxLocationIdParameter - - MailboxLocationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - MailboxLocationType - - MailboxLocationType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Get-MailboxLocation - - 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. - - UserIdParameter - - UserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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 - - MailboxLocationType - - MailboxLocationType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 <MailboxIdentity> | 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. - - MailboxLocationIdParameter - - MailboxLocationIdParameter - - - None - - - 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. - - UserIdParameter - - UserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - MailboxLocationType - - MailboxLocationType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MailboxLocation -User chris@contoso.com - - In Exchange Online, this example returns the mailbox location information for the user chris@contoso.com. - - - - -------------------------- Example 2 -------------------------- - 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 <MailboxIdentity> | Format-List ExchangeGuid`). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxlocation - - - - - - Get-MailboxMessageConfiguration - Get - MailboxMessageConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxMessageConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password to use to access the mailbox. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password to use to access the mailbox. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxmessageconfiguration - - - - - - Get-MailboxPermission - Get - MailboxPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxPermission - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-MailboxPermission - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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: For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - You can't use this parameter with the Owner parameter. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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: For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - You can't use this parameter with the Owner parameter. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxpermission - - - - - - Get-MailboxRegionalConfiguration - Get - MailboxRegionalConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - To modify the regional settings of a mailbox, use the Set-MailboxRegionalConfiguration (https://docs.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration)cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxRegionalConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxregionalconfiguration - - - - - - Get-MailboxSpellingConfiguration - Get - MailboxSpellingConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxSpellingConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxspellingconfiguration - - - - - - Get-MailboxUserConfiguration - Get - MailboxUserConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxUserConfiguration - - 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. - - MailboxUserConfigurationIdParameter - - MailboxUserConfigurationIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - - - 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. - - MailboxUserConfigurationIdParameter - - MailboxUserConfigurationIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxuserconfiguration - - - - - - Get-MailContact - Get - MailContact - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-MailContact cmdlet retrieves all attributes of the specified contact. No parameters are required. If the cmdlet is run without a parameter, a complete list of contacts for the Exchange organization is returned. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailContact - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-MailContact - - 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 - - MailContactIdParameter - - MailContactIdParameter - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - MailContactIdParameter - - MailContactIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailcontact - - - - - - Get-MailUser - Get - MailUser - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailUser - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - - Get-MailUser - - 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 - - MailUserIdParameter - - MailUserIdParameter - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - MailUserIdParameter - - MailUserIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 returns detailed information for the mail user named Ed. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailuser - - - - - - Get-ManagementRole - Get - ManagementRole - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can view management roles in several ways, from listing all the roles in your organization to listing only the child roles of a specified parent role. You can also view the details of a specific role by piping the output of the Get-ManagementRole cmdlet to the Format-List cmdlet. - For more information about management roles, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ManagementRole - - 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. - - RoleIdParameter - - RoleIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - RoleType - - The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - - RoleType - - RoleType - - - None - - - - Get-ManagementRole - - 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. - - RoleIdParameter - - RoleIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - RoleType - - The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - - RoleType - - RoleType - - - None - - - - Get-ManagementRole - - 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. - - RoleIdParameter - - RoleIdParameter - - - None - - - Cmdlet - - The Cmdlet parameter returns a list of all roles that include the specified cmdlet. - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - RoleType - - The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - - RoleType - - RoleType - - - None - - - - Get-ManagementRole - - 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. - - RoleIdParameter - - RoleIdParameter - - - None - - - RoleType - - The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - - RoleType - - RoleType - - - None - - - Script - - The Script parameter returns a list of all roles that include the specified script. - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - - - - 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. - - RoleIdParameter - - RoleIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Cmdlet - - The Cmdlet parameter returns a list of all roles that include the specified cmdlet. - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - RoleType - - The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - - RoleType - - RoleType - - - None - - - Script - - The Script parameter returns a list of all roles that include the specified script. - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-managementrole - - - - - - Get-ManagementRoleAssignment - Get - ManagementRoleAssignment - - This cmdlet is available in 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-ManagementRoleAssignment cmdlet to retrieve management role assignments. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can retrieve role assignments in a variety of ways including by assignment type, scope type, or name, and whether the assignment is enabled or disabled. You can also view a list of role assignments that provide access to a specified recipient, server, or database. - For more information about management role assignments, see Understanding management role assignments (https://docs.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ManagementRoleAssignment - - Identity - - The Identity parameter specifies the name of the role assignment to retrieve. If the name of the role assignment contains spaces, enclose it in quotation marks ("). If the RoleAssignee parameter is used, you can't use the Identity parameter. - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - ConfigWriteScope - - The ConfigWriteScope parameter specifies the type of management configuration scope to include in the results returned by the cmdlet. The valid values are None, OrganizationConfig, CustomConfigScope, and ExclusiveConfigScope. - - ConfigWriteScopeType - - ConfigWriteScopeType - - - None - - - CustomRecipientWriteScope - - The CustomRecipientWriteScope parameter returns only the regular role assignments that include the specified recipient-based regular scope. - This parameter can only be used to retrieve regular recipient-based scopes. To retrieve a list of exclusive recipient-based scopes, use the ExclusiveRecipientWriteScope parameter instead. - If the scope name contains spaces, enclose it in quotation marks ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Delegating - - The Delegating parameter specifies whether delegating or regular role assignments should be returned. - By default, both delegating and regular scopes are returned. To return only delegating role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. - - Boolean - - Boolean - - - None - - - Enabled - - The Enabled parameter specifies whether enabled or disabled role assignments should be returned. To return enabled role assignments, specify a value of $true. To return disabled role assignments, specify a value of $false. - - Boolean - - Boolean - - - None - - - Exclusive - - The Exclusive parameter specifies whether exclusive or regular role assignments should be returned. - By default, both exclusive and regular scopes are returned. To return only exclusive role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. - - Boolean - - Boolean - - - None - - - ExclusiveRecipientWriteScope - - The ExclusiveRecipientWriteScope parameter returns only the exclusive role assignments that include the specified recipient-based exclusive scope. - This parameter can only be used to retrieve exclusive recipient-based scopes. To retrieve a list of regular recipient-based scopes, use the CustomRecipientWriteScope parameter instead. - If the scope name contains spaces, enclose it in quotation marks ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - GetEffectiveUsers - - The GetEffectiveUsers switch specifies that the command should show the list of users in the role groups, assignment policies, or USGs associated with a role assignment. The users are effectively assigned the role assignment through their role group, assignment policy, or USG. - - - SwitchParameter - - - False - - - RecipientAdministrativeUnitScope - - This parameter is available or functional only in the cloud-based service. - The RecipientAdministrativeUnitScope parameter returns only the role assignments that include the specified administrative unit. - Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - RecipientOrganizationalUnitScope - - The RecipientOrganizationalUnitScope parameter returns only the role assignments that include the specified organizational unit (OU). If the OU tree contains spaces, enclose it in quotation marks ("). - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - RecipientWriteScope - - The RecipientWriteScope parameter returns only the role assignments associated with the recipient scope restriction type specified. The valid values are None, MyGAL, Self, OU, CustomRecipientScope, MyDistributionGroups and ExclusiveRecipientScope. - - RecipientWriteScopeType - - RecipientWriteScopeType - - - None - - - RoleAssigneeType - - The RoleAssigneeType parameter specifies the type of role assignee to return. The valid values are User, SecurityGroup, RoleAssignmentPolicy, ForeignSecurityPrincipal, RoleGroup, LinkedRoleGroup and Computer. - - RoleAssigneeType - - RoleAssigneeType - - - None - - - WritableRecipient - - The WritableRecipient parameter specifies the recipient object you want to test to determine which role assignments allow it to be modified. The command takes into account the roles and scopes associated with each role assignment. If the recipient name contains spaces, enclose it in quotation marks ("). - If this parameter is used with the GetEffectiveUsers switch, all of the users who can modify the recipient object indirectly through role groups and USGs are also returned. Without the GetEffectiveUsers switch, only the role groups, users and USGs directly assigned the role assignment are returned. - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - - Get-ManagementRoleAssignment - - AssignmentMethod - - The AssignmentMethod parameter specifies the type of role assignment to include in the results returned by the cmdlet. You can specify one or more of the following values: - - Direct - - SecurityGroup - - RoleGroup - - RoleAssignmentPolicy - - If you provide more than one value, separate each value with a comma. - You must specify a value with the RoleAssignee parameter if you use the AssignmentMethod parameter. - - AssignmentMethod[] - - AssignmentMethod[] - - - None - - - ConfigWriteScope - - The ConfigWriteScope parameter specifies the type of management configuration scope to include in the results returned by the cmdlet. The valid values are None, OrganizationConfig, CustomConfigScope, and ExclusiveConfigScope. - - ConfigWriteScopeType - - ConfigWriteScopeType - - - None - - - CustomRecipientWriteScope - - The CustomRecipientWriteScope parameter returns only the regular role assignments that include the specified recipient-based regular scope. - This parameter can only be used to retrieve regular recipient-based scopes. To retrieve a list of exclusive recipient-based scopes, use the ExclusiveRecipientWriteScope parameter instead. - If the scope name contains spaces, enclose it in quotation marks ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Delegating - - The Delegating parameter specifies whether delegating or regular role assignments should be returned. - By default, both delegating and regular scopes are returned. To return only delegating role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. - - Boolean - - Boolean - - - None - - - Enabled - - The Enabled parameter specifies whether enabled or disabled role assignments should be returned. To return enabled role assignments, specify a value of $true. To return disabled role assignments, specify a value of $false. - - Boolean - - Boolean - - - None - - - Exclusive - - The Exclusive parameter specifies whether exclusive or regular role assignments should be returned. - By default, both exclusive and regular scopes are returned. To return only exclusive role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. - - Boolean - - Boolean - - - None - - - ExclusiveRecipientWriteScope - - The ExclusiveRecipientWriteScope parameter returns only the exclusive role assignments that include the specified recipient-based exclusive scope. - This parameter can only be used to retrieve exclusive recipient-based scopes. To retrieve a list of regular recipient-based scopes, use the CustomRecipientWriteScope parameter instead. - If the scope name contains spaces, enclose it in quotation marks ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - GetEffectiveUsers - - The GetEffectiveUsers switch specifies that the command should show the list of users in the role groups, assignment policies, or USGs associated with a role assignment. The users are effectively assigned the role assignment through their role group, assignment policy, or USG. - - - SwitchParameter - - - False - - - RecipientAdministrativeUnitScope - - This parameter is available or functional only in the cloud-based service. - The RecipientAdministrativeUnitScope parameter returns only the role assignments that include the specified administrative unit. - Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - RecipientOrganizationalUnitScope - - The RecipientOrganizationalUnitScope parameter returns only the role assignments that include the specified organizational unit (OU). If the OU tree contains spaces, enclose it in quotation marks ("). - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - RecipientWriteScope - - The RecipientWriteScope parameter returns only the role assignments associated with the recipient scope restriction type specified. The valid values are None, MyGAL, Self, OU, CustomRecipientScope, MyDistributionGroups and ExclusiveRecipientScope. - - RecipientWriteScopeType - - RecipientWriteScopeType - - - None - - - Role - - The Role parameter returns only the role assignments associated with the specified management role. If the name of the role contains spaces, enclose it in quotation marks ("). - - RoleIdParameter - - RoleIdParameter - - - None - - - RoleAssignee - - The RoleAssignee parameter specifies the role group, assignment policy, user, or universal security group (USG) for which you want to view role assignments. If the RoleAssignee parameter is used, you can't use the Identity parameter. - By default, the command returns both direct role assignments to the role assignee and indirect role assignments granted to a role assignee through role groups or assignment policies. - If the name of the user or USG contains spaces, enclose it in quotation marks ("). - - RoleAssigneeIdParameter - - RoleAssigneeIdParameter - - - None - - - RoleAssigneeType - - The RoleAssigneeType parameter specifies the type of role assignee to return. The valid values are User, SecurityGroup, RoleAssignmentPolicy, ForeignSecurityPrincipal, RoleGroup, LinkedRoleGroup and Computer. - - RoleAssigneeType - - RoleAssigneeType - - - None - - - WritableRecipient - - The WritableRecipient parameter specifies the recipient object you want to test to determine which role assignments allow it to be modified. The command takes into account the roles and scopes associated with each role assignment. If the recipient name contains spaces, enclose it in quotation marks ("). - If this parameter is used with the GetEffectiveUsers switch, all of the users who can modify the recipient object indirectly through role groups and USGs are also returned. Without the GetEffectiveUsers switch, only the role groups, users and USGs directly assigned the role assignment are returned. - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the name of the role assignment to retrieve. If the name of the role assignment contains spaces, enclose it in quotation marks ("). If the RoleAssignee parameter is used, you can't use the Identity parameter. - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - AssignmentMethod - - The AssignmentMethod parameter specifies the type of role assignment to include in the results returned by the cmdlet. You can specify one or more of the following values: - - Direct - - SecurityGroup - - RoleGroup - - RoleAssignmentPolicy - - If you provide more than one value, separate each value with a comma. - You must specify a value with the RoleAssignee parameter if you use the AssignmentMethod parameter. - - AssignmentMethod[] - - AssignmentMethod[] - - - None - - - ConfigWriteScope - - The ConfigWriteScope parameter specifies the type of management configuration scope to include in the results returned by the cmdlet. The valid values are None, OrganizationConfig, CustomConfigScope, and ExclusiveConfigScope. - - ConfigWriteScopeType - - ConfigWriteScopeType - - - None - - - CustomRecipientWriteScope - - The CustomRecipientWriteScope parameter returns only the regular role assignments that include the specified recipient-based regular scope. - This parameter can only be used to retrieve regular recipient-based scopes. To retrieve a list of exclusive recipient-based scopes, use the ExclusiveRecipientWriteScope parameter instead. - If the scope name contains spaces, enclose it in quotation marks ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Delegating - - The Delegating parameter specifies whether delegating or regular role assignments should be returned. - By default, both delegating and regular scopes are returned. To return only delegating role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. - - Boolean - - Boolean - - - None - - - Enabled - - The Enabled parameter specifies whether enabled or disabled role assignments should be returned. To return enabled role assignments, specify a value of $true. To return disabled role assignments, specify a value of $false. - - Boolean - - Boolean - - - None - - - Exclusive - - The Exclusive parameter specifies whether exclusive or regular role assignments should be returned. - By default, both exclusive and regular scopes are returned. To return only exclusive role assignments, specify a value of $true. To return only regular role assignments, specify a value of $false. - - Boolean - - Boolean - - - None - - - ExclusiveRecipientWriteScope - - The ExclusiveRecipientWriteScope parameter returns only the exclusive role assignments that include the specified recipient-based exclusive scope. - This parameter can only be used to retrieve exclusive recipient-based scopes. To retrieve a list of regular recipient-based scopes, use the CustomRecipientWriteScope parameter instead. - If the scope name contains spaces, enclose it in quotation marks ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - GetEffectiveUsers - - The GetEffectiveUsers switch specifies that the command should show the list of users in the role groups, assignment policies, or USGs associated with a role assignment. The users are effectively assigned the role assignment through their role group, assignment policy, or USG. - - SwitchParameter - - SwitchParameter - - - False - - - RecipientAdministrativeUnitScope - - This parameter is available or functional only in the cloud-based service. - The RecipientAdministrativeUnitScope parameter returns only the role assignments that include the specified administrative unit. - Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - RecipientOrganizationalUnitScope - - The RecipientOrganizationalUnitScope parameter returns only the role assignments that include the specified organizational unit (OU). If the OU tree contains spaces, enclose it in quotation marks ("). - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - RecipientWriteScope - - The RecipientWriteScope parameter returns only the role assignments associated with the recipient scope restriction type specified. The valid values are None, MyGAL, Self, OU, CustomRecipientScope, MyDistributionGroups and ExclusiveRecipientScope. - - RecipientWriteScopeType - - RecipientWriteScopeType - - - None - - - Role - - The Role parameter returns only the role assignments associated with the specified management role. If the name of the role contains spaces, enclose it in quotation marks ("). - - RoleIdParameter - - RoleIdParameter - - - None - - - RoleAssignee - - The RoleAssignee parameter specifies the role group, assignment policy, user, or universal security group (USG) for which you want to view role assignments. If the RoleAssignee parameter is used, you can't use the Identity parameter. - By default, the command returns both direct role assignments to the role assignee and indirect role assignments granted to a role assignee through role groups or assignment policies. - If the name of the user or USG contains spaces, enclose it in quotation marks ("). - - RoleAssigneeIdParameter - - RoleAssigneeIdParameter - - - None - - - RoleAssigneeType - - The RoleAssigneeType parameter specifies the type of role assignee to return. The valid values are User, SecurityGroup, RoleAssignmentPolicy, ForeignSecurityPrincipal, RoleGroup, LinkedRoleGroup and Computer. - - RoleAssigneeType - - RoleAssigneeType - - - None - - - WritableRecipient - - The WritableRecipient parameter specifies the recipient object you want to test to determine which role assignments allow it to be modified. The command takes into account the roles and scopes associated with each role assignment. If the recipient name contains spaces, enclose it in quotation marks ("). - If this parameter is used with the GetEffectiveUsers switch, all of the users who can modify the recipient object indirectly through role groups and USGs are also returned. Without the GetEffectiveUsers switch, only the role groups, users and USGs directly assigned the role assignment are returned. - - GeneralRecipientIdParameter - - GeneralRecipientIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ManagementRoleAssignment "Denver Help Desk" | Format-List - - This example retrieves the Denver Help Desk role assignment using the Get-ManagementRoleAssignment cmdlet and pipes the output to the Format-List cmdlet. For more information about the Format-List cmdlet, see Working with command output (https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - -------------------------- Example 2 -------------------------- - Get-ManagementRoleAssignment -Enabled $true -Delegating $true - - This example retrieves all the role assignments that are enabled and have been designated as delegating role assignments. - - - - -------------------------- Example 3 -------------------------- - Get-ManagementRoleAssignment -RecipientWriteScope MyGAL - - This example retrieves all the role assignments that include the MyGAL recipient-based scope restriction type. - - - - -------------------------- Example 4 -------------------------- - Get-ManagementRoleAssignment -Role "Mail Recipients" - - This example retrieves all the role assignments associated with the Mail Recipients management role. - - - - -------------------------- Example 5 -------------------------- - Get-ManagementRoleAssignment -WritableRecipient Bob -GetEffectiveUsers - - This example retrieves a list of all the users and the role assignments that can modify the recipient Bob. - - - - -------------------------- Example 6 -------------------------- - Get-ManagementRoleAssignment -ExclusiveConfigWriteScope "Redmond Executive Servers" -GetEffectiveUsers - - This example retrieves a list of all exclusive scopes that can modify server objects that match Redmond Executive Servers. The command also lists the users who are effectively assigned the role assignments through role groups or USGs. - - - - -------------------------- Example 7 -------------------------- - Get-ManagementRoleAssignment -WritableDatabase "Contoso Sales" - - This example retrieves all the role assignments that can modify the database Contoso Sales. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-managementroleassignment - - - - - - Get-ManagementRoleEntry - Get - ManagementRoleEntry - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-ManagementRoleEntry cmdlet retrieves role entries that have been configured on roles. You can retrieve specific role entries that match specific criteria such as role name, cmdlet name, parameter name, or a combination of each, or role entry type or the associated Windows PowerShell snap-in. - For more information about management role entries, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ManagementRoleEntry - - Identity - - The Identity parameter specifies the role entry that you want to view. This parameter uses the syntax: `<management role><role entry name>` (for example, `CustomRole\Set-Mailbox`). - For more information about how management role entries work, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - 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 ("). - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - 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. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - ManagementRoleEntryType[] - - ManagementRoleEntryType[] - - - None - - - - - - Identity - - The Identity parameter specifies the role entry that you want to view. This parameter uses the syntax: `<management role><role entry name>` (for example, `CustomRole\Set-Mailbox`). - For more information about how management role entries work, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - 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 ("). - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - 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. - - String[] - - String[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - ManagementRoleEntryType[] - - ManagementRoleEntryType[] - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-managementroleentry - - - - - - Get-ManagementScope - Get - ManagementScope - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can retrieve one scope or many, retrieve only scopes that aren't associated with management role assignments, or retrieve scopes that are exclusive or regular scopes. - For more information about regular and exclusive scopes, see Understanding management role scopes (https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ManagementScope - - 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 ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Orphan - - The Orphan parameter returns only the management scopes that aren't associated with role assignments. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Orphan - - The Orphan parameter returns only the management scopes that aren't associated with role assignments. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-managementscope - - - - - - Get-OfflineAddressBook - Get - OfflineAddressBook - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OfflineAddressBook - - 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. - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - - - - 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. - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-offlineaddressbook - - - - - - Get-OnPremisesOrganization - Get - OnPremisesOrganization - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OnPremisesOrganization - - Identity - - The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - - Canonical name - - GUID - - Name - - OnPremisesOrganizationIdParameter - - OnPremisesOrganizationIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - - Canonical name - - GUID - - Name - - OnPremisesOrganizationIdParameter - - OnPremisesOrganizationIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-onpremisesorganization - - - - - - Get-PartnerApplication - Get - PartnerApplication - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can configure partner applications such as Microsoft SharePoint to access Exchange resources. For details, see Plan Exchange 2016 integration with SharePoint and Skype for Business (https://docs.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PartnerApplication - - Identity - - The Identity parameter specifies the identity of a partner application. - - PartnerApplicationIdParameter - - PartnerApplicationIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the identity of a partner application. - - PartnerApplicationIdParameter - - PartnerApplicationIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-partnerapplication - - - - - - Get-Recipient - Get - Recipient - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - In cloud environments, to return Microsoft 365 Groups, you need to use the RecipientTypeDetails parameter with the value GroupMailbox. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-Recipient cmdlet may not return all object-specific properties for a recipient. To view the object-specific properties for a recipient, you need to use the corresponding cmdlet based on the object type (for example, Get-Mailbox, Get-MailUser, or Get-DistributionGroup). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-Recipient - - 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 - - String - - String - - - None - - - 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 - - AuthenticationType - - AuthenticationType - - - None - - - Capabilities - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - Properties - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - PropertySet - - This parameter is reserved for internal Microsoft use. - - PropertySet - - PropertySet - - - None - - - 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. - - RecipientType[] - - RecipientType[] - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-Recipient - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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 - - AuthenticationType - - AuthenticationType - - - None - - - BookmarkDisplayName - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Capabilities - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - IncludeBookmarkObject - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - Properties - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - PropertySet - - This parameter is reserved for internal Microsoft use. - - PropertySet - - PropertySet - - - None - - - 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. - - RecipientType[] - - RecipientType[] - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-Recipient - - 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 - - AuthenticationType - - AuthenticationType - - - None - - - Capabilities - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - Properties - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - PropertySet - - This parameter is reserved for internal Microsoft use. - - PropertySet - - PropertySet - - - None - - - 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 Opath filter syntax `"Property -ComparisonOperator 'Value'"` (the same syntax as the RecipientFilter parameter). - - Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - - Property is a filterable property. For filterable recipient properties, see Filterable properties for the RecipientFilter parameter (https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - RecipientType[] - - RecipientType[] - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - 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 - - AuthenticationType - - AuthenticationType - - - None - - - BookmarkDisplayName - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Capabilities - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - IncludeBookmarkObject - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - Properties - - This parameter is reserved for internal Microsoft use. - - String[] - - String[] - - - None - - - PropertySet - - This parameter is reserved for internal Microsoft use. - - PropertySet - - PropertySet - - - None - - - 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 Opath filter syntax `"Property -ComparisonOperator 'Value'"` (the same syntax as the RecipientFilter parameter). - - Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - - Property is a filterable property. For filterable recipient properties, see Filterable properties for the RecipientFilter parameter (https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - RecipientType[] - - RecipientType[] - - - None - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-recipient - - - - - - Get-RoleAssignmentPolicy - Get - RoleAssignmentPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For more information about assignment policies, see Understanding management role assignment policies (https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RoleAssignmentPolicy - - Identity - - The Identity parameter specifies the name of the assignment policy to view. If the name contains spaces, enclose the name in quotation marks ("). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the name of the assignment policy to view. If the name contains spaces, enclose the name in quotation marks ("). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - -------------------------- 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 About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-roleassignmentpolicy - - - - - - Get-RoleGroup - Get - RoleGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For more information about role groups, see Understanding management role groups (https://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RoleGroup - - 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. - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can filter on the following properties: - - LinkedGroup - - ManagedBy - - Members - - Name - - RoleGroupType (the available values are Standard and Linked) - - DisplayName - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - ShowPartnerLinked - - This parameter is available or functional 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. - - - SwitchParameter - - - 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 - - String - - String - - - None - - - - - - 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. - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can filter on the following properties: - - LinkedGroup - - ManagedBy - - Members - - Name - - RoleGroupType (the available values are Standard and Linked) - - DisplayName - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - ShowPartnerLinked - - This parameter is available or functional 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. - - SwitchParameter - - SwitchParameter - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-rolegroup - - - - - - Get-RoleGroupMember - Get - RoleGroupMember - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For more information about role groups, see Understanding management role groups (https://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RoleGroupMember - - 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 ("). - - RoleGroupMemberIdParameter - - RoleGroupMemberIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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 ("). - - RoleGroupMemberIdParameter - - RoleGroupMemberIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-rolegroupmember - - - - - - Get-SiteMailbox - Get - SiteMailbox - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes (https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). - Use the Get-SiteMailbox cmdlet to view information about site mailboxes. This cmdlet is primarily used by Microsoft SharePoint and Exchange to display information to users in the user interface. However, you may find it helpful for discovering information such as the site mailbox's owners, members, and lifecycle status. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If you aren't a member or owner of the site mailbox that you want to view the diagnostics information for, you must use the BypassOwnerCheck parameter when running this cmdlet. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SiteMailbox - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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 - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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 - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-sitemailbox - - - - - - Get-SiteMailboxDiagnostics - Get - SiteMailboxDiagnostics - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes (https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). - Use the Get-SiteMailboxDiagnostics cmdlet to view important event-related data for each site mailbox. This information can be used to troubleshoot site mailbox issues. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If you aren't a member or owner of the site mailbox that you want to view the diagnostics information for, you must use the BypassOwnerCheck parameter when running this cmdlet. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SiteMailboxDiagnostics - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-sitemailboxdiagnostics - - - - - - Get-TenantAnalyticsConfig - Get - TenantAnalyticsConfig - - This cmdlet is available only in the cloud-based service. - This cmdlet has been deprecated and no longer used. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet has been deprecated and no longer used. - - - - Get-TenantAnalyticsConfig - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TenantAnalyticsConfig - - This cmdlet has been deprecated and no longer used. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-tenantanalyticsconfig - - - - - - Get-UnifiedGroup - Get - UnifiedGroup - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Microsoft 365 Groups are group objects that are available across Microsoft 365 services. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UnifiedGroup - - Anr - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-UnifiedGroup - - 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. - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - Anr - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-UnifiedGroup - - This example returns a summary list of all Microsoft 365 Groups. - - - - -------------------------- Example 2 -------------------------- - 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 -------------------------- - Get-UnifiedGroup -Identity "Marketing Department" | Format-List - - This example returns detailed information about the Microsoft 365 Group named Marketing Department. - - - - -------------------------- Example 4 -------------------------- - Get-UnifiedGroup | Where-Object {-Not $_.ManagedBy} - - This example returns Microsoft 365 Groups that do not have an owner. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-unifiedgroup - - - - - - Get-UnifiedGroupLinks - Get - UnifiedGroupLinks - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Microsoft 365 Groups are group objects that are available across Microsoft 365 services. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UnifiedGroupLinks - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - LinkType - - The LinkType parameter specifies the Microsoft 365 Group property that you want to view. Valid values are: - - Aggregators - - Members - - Owners - - Subscribers - - LinkType - - LinkType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - LinkType - - The LinkType parameter specifies the Microsoft 365 Group property that you want to view. Valid values are: - - Aggregators - - Members - - Owners - - Subscribers - - LinkType - - LinkType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-UnifiedGroupLinks -Identity "Human Resources Department" -LinkType Members - - This example show the members of the Microsoft 365 Group named Human Resources Department - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-unifiedgrouplinks - - - - - - Get-User - Get - User - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-User cmdlet returns no mail-related properties for mailboxes or mail users. To view the mail-related properties for a user, you need to use the corresponding cmdlet based on the object type (for example, Get-Mailbox or Get-MailUser). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-User - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-User - - Identity - - The Identity parameter the user that you want to view. You can use any value that uniquely identifies the user. For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - UserIdParameter - - UserIdParameter - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - Identity - - The Identity parameter the user that you want to view. You can use any value that uniquely identifies the user. For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - UserIdParameter - - UserIdParameter - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-user - - - - - - Get-UserAnalyticsConfig - Get - UserAnalyticsConfig - - This cmdlet is available only in the cloud-based service. Note : This cmdlet has been replaced by the Get-MyAnalyticsFeatureConfig cmdlet in the Exchange Online PowerShell V2 module version 2.0.4 or later. For connection instructions using the module, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - Use the Get-UserAnalyticsConfig 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UserAnalyticsConfig - - Identity - - The Identity parameter specifies the user that you want to view. You can use any value that uniquely identifies the user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - RecipientIdParameter - - RecipientIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the user that you want to view. You can use any value that uniquely identifies the user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - RecipientIdParameter - - RecipientIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-UserAnalyticsConfig -Identity KathleenReiter@Contoso.com - - This example returns the MyAnalytics privacy setting for the user with email address KathleenReiter@Contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-useranalyticsconfig - - - - - - Get-UserPhoto - Get - UserPhoto - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-UserPhoto - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - - Get-UserPhoto - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Identity - - The Identity parameter specifies the user account. You can use any value that uniquely identifies the user account. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-userphoto - - - - - - Import-RecipientDataProperty - Import - RecipientDataProperty - - 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 Outlook and Outlook on the web. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Importing and exporting files require a specific syntax because importing and exporting use Remote PowerShell. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Import-RecipientDataProperty - - 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 - - MailboxUserContactIdParameter - - MailboxUserContactIdParameter - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Import-RecipientDataProperty - - 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 - - MailboxUserContactIdParameter - - MailboxUserContactIdParameter - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - MailboxUserContactIdParameter - - MailboxUserContactIdParameter - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/import-recipientdataproperty - - - - - - New-AddressBookPolicy - New - AddressBookPolicy - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-AddressBookPolicy - - Name - - The Name parameter specifies the name of the address book policy. - - String - - String - - - None - - - 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". - - AddressListIdParameter[] - - AddressListIdParameter[] - - - None - - - 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. - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - 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. - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - 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. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the name of the address book policy. - - String - - String - - - None - - - 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". - - AddressListIdParameter[] - - AddressListIdParameter[] - - - None - - - 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. - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - 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. - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - 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. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-addressbookpolicy - - - - - - New-AddressList - New - AddressList - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-AddressList - - 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 ("). - - String - - String - - - None - - - 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). - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 (\). - - AddressListIdParameter - - AddressListIdParameter - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-AddressList - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 (\). - - AddressListIdParameter - - AddressListIdParameter - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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). - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). - - String - - String - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 (\). - - AddressListIdParameter - - AddressListIdParameter - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-AddressList -Name MyAddressList -RecipientFilter "((RecipientType -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 -------------------------- - 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 '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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-addresslist - - - - - - New-AuthenticationPolicy - New - AuthenticationPolicy - - This cmdlet is available in 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-AuthenticationPolicy - - 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 ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-authenticationpolicy - - - - - - New-EmailAddressPolicy - New - EmailAddressPolicy - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the New-EmailAddressPolicy cmdlet to create email address policies. In Exchange Online, email address policies are only available for Microsoft 365 Groups. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-EmailAddressPolicy - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. - AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - 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. - - ProxyAddressTemplateCollection - - ProxyAddressTemplateCollection - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - EmailAddressPolicyPriority - - EmailAddressPolicyPriority - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-EmailAddressPolicy - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. - AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - 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. - - ProxyAddressTemplateCollection - - ProxyAddressTemplateCollection - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - EmailAddressPolicyPriority - - EmailAddressPolicyPriority - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-EmailAddressPolicy - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. - AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - 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. - - ProxyAddressTemplateCollection - - ProxyAddressTemplateCollection - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - You can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - For more information, see Choose the domain to use when creating Microsoft 365 Groups (https://docs.microsoft.com/microsoft-365/admin/create-groups/choose-domain-to-create-groups). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can only use this parameter in Exchange Online PowerShell with the IncludeUnifiedGroupRecipients switch. - - String - - String - - - None - - - 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. - - EmailAddressPolicyPriority - - EmailAddressPolicyPriority - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-EmailAddressPolicy - - 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 ("). - - String - - String - - - None - - - 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 Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - You can't use this parameter with the EnabledEmailAddressTemplates parameter. - In Exchange Online PowerShell, you can't use variables in the email address template. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - EmailAddressPolicyPriority - - EmailAddressPolicyPriority - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-EmailAddressPolicy - - 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 ("). - - String - - String - - - None - - - 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 Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - You can't use this parameter with the EnabledEmailAddressTemplates parameter. - In Exchange Online PowerShell, you can't use variables in the email address template. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - EmailAddressPolicyPriority - - EmailAddressPolicyPriority - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-EmailAddressPolicy - - 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 ("). - - String - - String - - - None - - - 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 Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - You can't use this parameter with the EnabledEmailAddressTemplates parameter. - In Exchange Online PowerShell, you can't use variables in the email address template. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - You can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - For more information, see Choose the domain to use when creating Microsoft 365 Groups (https://docs.microsoft.com/microsoft-365/admin/create-groups/choose-domain-to-create-groups). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can only use this parameter in Exchange Online PowerShell with the IncludeUnifiedGroupRecipients switch. - - String - - String - - - None - - - 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. - - EmailAddressPolicyPriority - - EmailAddressPolicyPriority - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. - AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - 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. - - ProxyAddressTemplateCollection - - ProxyAddressTemplateCollection - - - None - - - 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 Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - You can't use this parameter with the EnabledEmailAddressTemplates parameter. - In Exchange Online PowerShell, you can't use variables in the email address template. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - You can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - For more information, see Choose the domain to use when creating Microsoft 365 Groups (https://docs.microsoft.com/microsoft-365/admin/create-groups/choose-domain-to-create-groups). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can only use this parameter in Exchange Online PowerShell with the IncludeUnifiedGroupRecipients switch. - - String - - String - - - None - - - 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. - - EmailAddressPolicyPriority - - EmailAddressPolicyPriority - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-emailaddresspolicy - - - - - - New-EOPDistributionGroup - New - EOPDistributionGroup - - This cmdlet is available only in Exchange Online Protection. - Use the New-EOPDistributionGroup cmdlet to create distribution groups or mail-enabled security groups in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the New-DistributionGroup cmdlet instead. - Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the New-EOPDistributionGroup cmdlet to create the following types of groups: - - Mail-enabled universal security group (USG) - - Universal distribution group - - Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Security groups are used to grant permissions to multiple users. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-EOPDistributionGroup - - 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. - - String - - String - - - None - - - ManagedBy - - The ManagedBy parameter specifies a user who owns the group. You need to use this parameter to specify at least one group owner. You can use any value that uniquely identifies the user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - You can specify multiple owners by using the following syntax: `@("User1","User2",..."UserN")`. - The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - - String[] - - String[] - - - None - - - 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 following 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. - If you don't use the Alias parameter when you create a group, the value of the Name parameter is used for the alias. This value is also used in the primary SMTP email address. Spaces are removed and unsupported characters are converted to question marks (?). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Members - - The Members parameter specifies the initial list of recipients (mail-enabled objects) in the distribution group. In Exchange Online Protection, the valid recipient types are: - - Mail users - - Distribution groups - - Mail-enabled security groups - - You can use any value that uniquely identifies the recipient. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - You can specify multiple recipients by using the following syntax: `@("Recipient1","Recipient2",..."RecipientN")`. - - String[] - - String[] - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - - SmtpAddress - - SmtpAddress - - - None - - - Type - - The Type parameter specifies the group type. Valid values are: - - Distribution (This is the default value). - - Security - - GroupType - - GroupType - - - None - - - - - - 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. - - String - - String - - - None - - - ManagedBy - - The ManagedBy parameter specifies a user who owns the group. You need to use this parameter to specify at least one group owner. You can use any value that uniquely identifies the user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - You can specify multiple owners by using the following syntax: `@("User1","User2",..."UserN")`. - The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - - String[] - - String[] - - - None - - - 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 following 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. - If you don't use the Alias parameter when you create a group, the value of the Name parameter is used for the alias. This value is also used in the primary SMTP email address. Spaces are removed and unsupported characters are converted to question marks (?). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Members - - The Members parameter specifies the initial list of recipients (mail-enabled objects) in the distribution group. In Exchange Online Protection, the valid recipient types are: - - Mail users - - Distribution groups - - Mail-enabled security groups - - You can use any value that uniquely identifies the recipient. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - You can specify multiple recipients by using the following syntax: `@("Recipient1","Recipient2",..."RecipientN")`. - - String[] - - String[] - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - - SmtpAddress - - SmtpAddress - - - None - - - Type - - The Type parameter specifies the group type. Valid values are: - - Distribution (This is the default value). - - Security - - GroupType - - GroupType - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-eopdistributiongroup - - - - - - New-EOPMailUser - New - EOPMailUser - - This cmdlet is available only in Exchange Online Protection. - Use the New-EOPMailUser cmdlet to create mail users, also known as mail-enabled users, in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the New-MailUser cmdlet instead. - Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-EOPMailUser - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - 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. - - String - - String - - - None - - - Password - - The Password parameter specifies the password for the user's account. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - String - - String - - - None - - - Alias - - The Alias parameter specifies the alias of the mail user. - The value of Alias can contain letters, numbers and the following 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. - If you don't use the Alias parameter when you create a mail user, the left side of the MicrosoftOnlineServicesID parameter value is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias value helpdesk. - - String - - String - - - None - - - DisplayName - - The DisplayName parameter specifies the name of the mail user in the Exchange admin center (EAC). - If you don't use this parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - ExternalEmailAddress - - The ExternalEmailAddress parameter specifies the user's email address that's outside of the Exchange Online Protection organization. Email messages sent to the mail user are relayed to this external address. - If you don't use this parameter, the value of the MicrosoftOnlineServicesID parameter is used for the external email address. - - ProxyAddress - - ProxyAddress - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - 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. - - String - - String - - - None - - - Password - - The Password parameter specifies the password for the user's account. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - String - - String - - - None - - - Alias - - The Alias parameter specifies the alias of the mail user. - The value of Alias can contain letters, numbers and the following 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. - If you don't use the Alias parameter when you create a mail user, the left side of the MicrosoftOnlineServicesID parameter value is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias value helpdesk. - - String - - String - - - None - - - DisplayName - - The DisplayName parameter specifies the name of the mail user in the Exchange admin center (EAC). - If you don't use this parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - ExternalEmailAddress - - The ExternalEmailAddress parameter specifies the user's email address that's outside of the Exchange Online Protection organization. Email messages sent to the mail user are relayed to this external address. - If you don't use this parameter, the value of the MicrosoftOnlineServicesID parameter is used for the external email address. - - ProxyAddress - - ProxyAddress - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-eopmailuser - - - - - - New-GlobalAddressList - New - GlobalAddressList - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-GlobalAddressList - - 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 ("). - - String - - String - - - None - - - 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). - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-GlobalAddressList - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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). - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). - - String - - String - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-globaladdresslist - - - - - - New-Mailbox - New - Mailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - Discovery - - The Discovery switch is required to create Discovery mailboxes. You don't need to specify a value with this switch. - Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be repurposed or converted to another type of mailbox. For more information, see In-Place eDiscovery in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). - - - SwitchParameter - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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 Skype for Business Room System or Microsoft Teams Rooms. - In Exchange Online, a room mailbox with an associated enabled account doesn't require a license. - - Boolean - - Boolean - - - None - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - 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, 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. - - - SwitchParameter - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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: - - Exchange Online: The Organization Management role group via the Mail Recipients, Reset Password, and User Options roles, the Help Desk role group via the Reset Password and User Options roles, or the Recipient Management role group via the Mail Recipients and Reset Password roles. - - On-premises Exchange: The Organization Management role group via the Mail Recipients and User Options roles, the Recipient Management role group via the Mail Recipients role, or the Help Desk role group via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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). - - - SwitchParameter - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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). - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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). - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - UserIdParameter - - UserIdParameter - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - UserIdParameter - - UserIdParameter - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - Phone - - The Phone parameter specifies the user's telephone number. - - String - - String - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - Migration - - The Migration switch is required to create migration mailboxes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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, 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. - - - SwitchParameter - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - Phone - - The Phone parameter specifies the user's telephone number. - - String - - String - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Scheduling - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - - SwitchParameter - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-Mailbox - - 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 ("). - - String - - String - - - None - - - RemovedMailbox - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - RemovedMailboxIdParameter - - RemovedMailboxIdParameter - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - Discovery - - The Discovery switch is required to create Discovery mailboxes. You don't need to specify a value with this switch. - Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be repurposed or converted to another type of mailbox. For more information, see In-Place eDiscovery in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). - - SwitchParameter - - SwitchParameter - - - 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 Skype for Business Room System or Microsoft Teams Rooms. - In Exchange Online, a room mailbox with an associated enabled account doesn't require a license. - - Boolean - - Boolean - - - None - - - 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). - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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). - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - UserIdParameter - - UserIdParameter - - - None - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - Migration - - The Migration switch is required to create migration mailboxes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - RemovedMailbox - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - RemovedMailboxIdParameter - - RemovedMailboxIdParameter - - - None - - - 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, 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - Phone - - The Phone parameter specifies the user's telephone number. - - String - - String - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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: - - Exchange Online: The Organization Management role group via the Mail Recipients, Reset Password, and User Options roles, the Help Desk role group via the Reset Password and User Options roles, or the Recipient Management role group via the Mail Recipients and Reset Password roles. - - On-premises Exchange: The Organization Management role group via the Mail Recipients and User Options roles, the Recipient Management role group via the Mail Recipients role, or the Help Desk role group via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - Scheduling - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - TargetAllMDBs - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mailbox - - - - - - New-MailboxFolder - New - MailboxFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If no parent folder is specified, the cmdlet creates a mail folder in the root folder hierarchy of the mailbox. If the mailbox isn't specified, the cmdlet creates the folder in the mailbox of the user currently running the task. When run, the cmdlet returns the new folder name and the folder path as the output. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). . - - - - New-MailboxFolder - - Name - - The Name parameter specifies the name of the new folder. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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` - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the name of the new folder. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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` - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-MailboxFolder -Parent :\Inbox -Name Personal - - This example creates the folder named Personal under the Inbox folder of your own mailbox. - - - - -------------------------- Example 2 -------------------------- - New-MailboxFolder -Parent :\ -Name Personal - - This example creates the folder named Personal in the root folder hierarchy of your own mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mailboxfolder - - - - - - New-MailContact - New - MailContact - - This cmdlet is available in 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-MailContact cmdlet to create mail contacts. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MailContact - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the mail contact. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MacAttachmentFormat - - MacAttachmentFormat - - - None - - - 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. - - MessageBodyFormat - - MessageBodyFormat - - - None - - - MessageFormat - - 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. - - MessageFormat - - MessageFormat - - - None - - - 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: - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the mail contact. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MacAttachmentFormat - - MacAttachmentFormat - - - None - - - 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. - - MessageBodyFormat - - MessageBodyFormat - - - None - - - MessageFormat - - 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. - - MessageFormat - - MessageFormat - - - None - - - 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: - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-MailContact -Name "Chris Ashton" -ExternalEmailAddress "chris@tailspintoys.com" - - This example creates a new mail contact named Chris Ashton. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mailcontact - - - - - - New-MailUser - New - MailUser - - This cmdlet is available in 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-MailUser cmdlet to create mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. Email messages sent to mail users are delivered to the specified external email address. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MailUser - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MacAttachmentFormat - - MacAttachmentFormat - - - None - - - MailboxRegion - - This parameter is available only in the cloud-based service - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - MessageBodyFormat - - MessageBodyFormat - - - None - - - 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. - - MessageFormat - - MessageFormat - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MailUser - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - Password - - The Password parameter specifies the password for the user's account. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MacAttachmentFormat - - MacAttachmentFormat - - - None - - - MailboxRegion - - This parameter is available only in the cloud-based service - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - MessageBodyFormat - - MessageBodyFormat - - - None - - - 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. - - MessageFormat - - MessageFormat - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MailUser - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - Password - - The Password parameter specifies the password for the user's account. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - MailboxRegion - - This parameter is available only in the cloud-based service - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MailUser - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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. - - String - - String - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - MailboxRegion - - This parameter is available only in the cloud-based service - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MailUser - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - MailboxRegion - - This parameter is available only in the cloud-based service - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-MailUser - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - MailboxRegion - - This parameter is available only in the cloud-based service - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 ("). - This value is also used for the DisplayName property if you don't use the DisplayName parameter. - - String - - String - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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. - - String - - String - - - None - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - Password - - The Password parameter specifies the password for the user's account. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 following 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). - If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - 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. - - MacAttachmentFormat - - MacAttachmentFormat - - - None - - - MailboxRegion - - This parameter is available only in the cloud-based service - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - MessageBodyFormat - - MessageBodyFormat - - - None - - - 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. - - MessageFormat - - MessageFormat - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-MailUser -Name "Ed Meadows" -ExternalEmailAddress ed@tailspintoys.com -MicrosoftOnlineServicesID ed@tailspintoys -Password (ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force) - - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mailuser - - - - - - New-ManagementRole - New - ManagementRole - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). - After you create a role, you can change the management role entries on the role and assign the role with a management scope to a user or universal security group (USG). - For more information about management roles, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-ManagementRole - - 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 ("). - - String - - String - - - None - - - 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. - - RoleIdParameter - - RoleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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. - - RoleIdParameter - - RoleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines)- Working with command output (https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help) - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-managementrole - - - - - - New-ManagementRoleAssignment - New - ManagementRoleAssignment - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-ManagementRoleAssignment - - 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. - - String - - String - - - None - - - 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 ("). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Role - - The Role parameter specifies the existing role to assign. If the role name contains spaces, enclose the name in quotation marks ("). - - RoleIdParameter - - RoleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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 ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - 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 ("). - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientWriteScopeType - - RecipientWriteScopeType - - - None - - - 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 Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - The UnScopedTopLevel switch specifies that the role provided with the Role parameter is an unscoped top-level management role. You don't need to specify a value with this switch. - Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see Create an unscoped role (https://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-ManagementRoleAssignment - - 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. - - String - - String - - - None - - - Role - - The Role parameter specifies the existing role to assign. If the role name contains spaces, enclose the name in quotation marks ("). - - RoleIdParameter - - RoleIdParameter - - - None - - - 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 ("). - - SecurityGroupIdParameter - - SecurityGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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 ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - 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 ("). - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientWriteScopeType - - RecipientWriteScopeType - - - None - - - 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 Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - The UnScopedTopLevel switch specifies that the role provided with the Role parameter is an unscoped top-level management role. You don't need to specify a value with this switch. - Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see Create an unscoped role (https://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-ManagementRoleAssignment - - 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. - - String - - String - - - None - - - Role - - The Role parameter specifies the existing role to assign. If the role name contains spaces, enclose the name in quotation marks ("). - - RoleIdParameter - - RoleIdParameter - - - None - - - 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 ("). - - UserIdParameter - - UserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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 ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - 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 ("). - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientWriteScopeType - - RecipientWriteScopeType - - - None - - - 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 Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - The UnScopedTopLevel switch specifies that the role provided with the Role parameter is an unscoped top-level management role. You don't need to specify a value with this switch. - Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see Create an unscoped role (https://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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 ("). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Role - - The Role parameter specifies the existing role to assign. If the role name contains spaces, enclose the name in quotation marks ("). - - RoleIdParameter - - RoleIdParameter - - - None - - - 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 ("). - - SecurityGroupIdParameter - - SecurityGroupIdParameter - - - None - - - 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 ("). - - UserIdParameter - - UserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - 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 ("). - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - RecipientWriteScopeType - - RecipientWriteScopeType - - - None - - - 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 Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - The UnScopedTopLevel switch specifies that the role provided with the Role parameter is an unscoped top-level management role. You don't need to specify a value with this switch. - Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see Create an unscoped role (https://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-managementroleassignment - - - - - - New-ManagementScope - New - ManagementScope - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - After you create a regular or exclusive scope, you need to associate the scope with a management role assignment. To associate a scope with a role assignment, use the New-ManagementRoleAssignment cmdlet. For more information about adding new management scopes, see Create a regular or exclusive scope (https://docs.microsoft.com/exchange/create-a-regular-or-exclusive-scope-exchange-2013-help). - For more information about regular and exclusive scopes, see Understanding management role scopes (https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-ManagementScope - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, ServerList, or ServerRestrictionFilter parameters. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Force - - The Force switch specifies that an exclusive scope should be created without showing the warning that the exclusive scope takes effect immediately. - - - SwitchParameter - - - 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. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-ManagementScope - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Force - - The Force switch specifies that an exclusive scope should be created without showing the warning that the exclusive scope takes effect immediately. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-ManagementScope - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Force - - The Force switch specifies that an exclusive scope should be created without showing the warning that the exclusive scope takes effect immediately. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-ManagementScope - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Force - - The Force switch specifies that an exclusive scope should be created without showing the warning that the exclusive scope takes effect immediately. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-ManagementScope - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Force - - The Force switch specifies that an exclusive scope should be created without showing the warning that the exclusive scope takes effect immediately. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, ServerList, or ServerRestrictionFilter parameters. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Force - - The Force switch specifies that an exclusive scope should be created without showing the warning that the exclusive scope takes effect immediately. - - SwitchParameter - - SwitchParameter - - - 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. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-managementscope - - - - - - New-OfflineAddressBook - New - OfflineAddressBook - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-OfflineAddressBook - - 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. - - String - - String - - - None - - - 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. - - AddressBookBaseIdParameter[] - - AddressBookBaseIdParameter[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - AddressBookBaseIdParameter[] - - AddressBookBaseIdParameter[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 (https://docs.microsoft.com/previous-versions/office/exchange-server-2010/bb124411(v=exchg.141)). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-offlineaddressbook - - - - - - New-OnPremisesOrganization - New - OnPremisesOrganization - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The OnPremisesOrganization object represents an on-premises Microsoft Exchange organization configured for hybrid deployment with a Microsoft 365 organization. It's used with the Hybrid Configuration wizard and is typically created automatically when the hybrid deployment is initially configured by the wizard. Manual modification of this object may result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-OnPremisesOrganization - - Name - - The Name parameter specifies a friendly name for the on-premises Exchange organization object in the Microsoft 365 organization. - - String - - String - - - None - - - 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". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - OrganizationGuid - - The OrganizationGuid parameter specifies the globally unique identifier (GUID) of the on-premises Exchange organization object in the Microsoft 365 organization. - - Guid - - Guid - - - None - - - 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. - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - OrganizationName - - The OrganizationName parameter specifies the Active Directory object name of the on-premises Exchange organization. - - String - - String - - - None - - - 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. - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - Name - - The Name parameter specifies a friendly name for the on-premises Exchange organization object in the Microsoft 365 organization. - - String - - String - - - None - - - OrganizationGuid - - The OrganizationGuid parameter specifies the globally unique identifier (GUID) of the on-premises Exchange organization object in the Microsoft 365 organization. - - Guid - - Guid - - - None - - - 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. - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - OrganizationName - - The OrganizationName parameter specifies the Active Directory object name of the on-premises Exchange organization. - - String - - String - - - None - - - 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. - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 a Microsoft 365 organization for the hybrid domains contoso.com and sales.contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-onpremisesorganization - - - - - - New-PartnerApplication - New - PartnerApplication - - This cmdlet is available or functional only in on-premises Exchange. - Use the New-PartnerApplication cmdlet to create partner application configurations in on-premises Exchange organizations. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see Plan Exchange 2016 integration with SharePoint and Skype for Business (https://docs.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). - We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-PartnerApplication - - Name - - The Name parameter specifies a name for the partner application. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - SupportedAccountType - - SupportedAccountType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UserIdParameter - - UserIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a name for the partner application. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - SupportedAccountType - - SupportedAccountType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UserIdParameter - - UserIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-PartnerApplication -Name HRApp -ApplicationIdentifier 00000006-0000-0dd1-ac00-000000000000 - - This example creates a new HRApp partner application named HRApp. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-partnerapplication - - - - - - New-RoleAssignmentPolicy - New - RoleAssignmentPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When you create an assignment policy, you can assign it to users using the New-Mailbox, Set-Mailbox, or Enable-Mailbox cmdlets. If you make the new assignment policy the default assignment policy, it's assigned to all new mailboxes that don't have an explicit assignment policy assigned to them. - You can add management roles to the new assignment policy when you create it, or you can create the assignment policy and add roles later. You must assign at least one management role to the new assignment policy for it to apply permissions to a mailbox. Without any roles assigned to the new assignment policy, users assigned to it won't be able to manage their mailbox configuration. To assign a management role after the assignment policy has been created, use the New-ManagementRoleAssignment cmdlet. For more information, see Manage role assignment policies (https://docs.microsoft.com/Exchange/permissions/role-assignment-policies). - For more information about assignment policies, see Understanding management role assignment policies (https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-RoleAssignmentPolicy - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DomainController - - This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - - Fqdn - - Fqdn - - - None - - - 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. - - - SwitchParameter - - - False - - - Roles - - The Roles parameter specifies the management roles to assign to the role assignment policy when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. - For a list of built-in management roles that you can assign to a role group, see Built-in management roles (https://docs.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). - - RoleIdParameter[] - - RoleIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DomainController - - This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - - Fqdn - - Fqdn - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Roles - - The Roles parameter specifies the management roles to assign to the role assignment policy when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. - For a list of built-in management roles that you can assign to a role group, see Built-in management roles (https://docs.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). - - RoleIdParameter[] - - RoleIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-roleassignmentpolicy - - - - - - New-RoleGroup - New - RoleGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-RoleGroup - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Roles - - The Roles parameter specifies the management roles to assign to the role group when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. - For a list of built-in management roles that you can assign to a role group, see Built-in management roles (https://docs.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). - - RoleIdParameter[] - - RoleIdParameter[] - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Roles - - The Roles parameter specifies the management roles to assign to the role group when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. - For a list of built-in management roles that you can assign to a role group, see Built-in management roles (https://docs.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). - - RoleIdParameter[] - - RoleIdParameter[] - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 About Variables (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_variables). - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-rolegroup - - - - - - New-SiteMailbox - New - SiteMailbox - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes (https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). - The New-SiteMailbox cmdlet is used by the Microsoft SharePoint and Microsoft Exchange user interfaces to create site mailboxes. We recommend that you don't use this cmdlet; instead use SharePoint to create the site mailbox. This cmdlet should only be used for diagnostic and troubleshooting purposes. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-SiteMailbox - - DisplayName - - The DisplayName parameter specifies the display name that displays in the user's global address list and on SharePoint. - - String - - String - - - None - - - SharePointUrl - - The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu". - - Uri - - Uri - - - None - - - Alias - - The Alias parameter specifies the alias of the site mailbox. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Name - - The Name parameter specifies the name of the site mailbox. - - String - - String - - - None - - - OrganizationalUnit - - The OrganizationalUnit parameter specifies the organizational unit in which the site mailbox resides. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - DisplayName - - The DisplayName parameter specifies the display name that displays in the user's global address list and on SharePoint. - - String - - String - - - None - - - SharePointUrl - - The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu". - - Uri - - Uri - - - None - - - Alias - - The Alias parameter specifies the alias of the site mailbox. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Name - - The Name parameter specifies the name of the site mailbox. - - String - - String - - - None - - - OrganizationalUnit - - The OrganizationalUnit parameter specifies the organizational unit in which the site mailbox resides. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-SiteMailbox - - You can't run this cmdlet from the Exchange Management Shell. Use SharePoint to create a site mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-sitemailbox - - - - - - New-UnifiedGroup - New - UnifiedGroup - - 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 : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Microsoft 365 Groups are group objects that are available across Microsoft 365 services. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-UnifiedGroup - - 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. - - String - - String - - - None - - - 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 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. - - ModernGroupTypeInfo - - ModernGroupTypeInfo - - - None - - - 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 value of Alias can contain letters, numbers and the following 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. - 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 (`<Alias>_<ExternalDirectoryObjectId>`). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Classification - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - ExecutingUser - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - ExoErrorAsWarning - - The ExoErrorAsWarning switch specifies that Exchange Online errors that you encounter while creating the Microsoft 365 Group are treated as warnings, not errors. You don't need to specify a value with this switch. - Creating Microsoft 365 Groups involves background operations in Azure Active Directory and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Azure Active Directory is synchronized back to Exchange Online. - - - SwitchParameter - - - 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 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. - - - SwitchParameter - - - False - - - Language - - The Language parameter specifies the language preference for the Microsoft 365 Group. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - MailboxRegion - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - ManagedBy - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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_<RandomGUID>`). Now, the value of the Name property is populated by the Alias parameter value and the ExternalDirectoryObjectId property value (`<Alias>_<ExternalDirectoryObjectId>`). - - String - - String - - - None - - - Notes - - The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SuppressWarmupMessage - - This parameter has been deprecated and is no longer used. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-UnifiedGroup - - 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. - - String - - String - - - None - - - 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 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. - - ModernGroupTypeInfo - - ModernGroupTypeInfo - - - None - - - 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 value of Alias can contain letters, numbers and the following 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. - 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 (`<Alias>_<ExternalDirectoryObjectId>`). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Classification - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - ExecutingUser - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - ExoErrorAsWarning - - The ExoErrorAsWarning switch specifies that Exchange Online errors that you encounter while creating the Microsoft 365 Group are treated as warnings, not errors. You don't need to specify a value with this switch. - Creating Microsoft 365 Groups involves background operations in Azure Active Directory and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Azure Active Directory is synchronized back to Exchange Online. - - - SwitchParameter - - - 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 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. - - - SwitchParameter - - - False - - - Language - - The Language parameter specifies the language preference for the Microsoft 365 Group. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - ManagedBy - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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_<RandomGUID>`). Now, the value of the Name property is populated by the Alias parameter value and the ExternalDirectoryObjectId property value (`<Alias>_<ExternalDirectoryObjectId>`). - - String - - String - - - None - - - Notes - - The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SuppressWarmupMessage - - This parameter has been deprecated and is no longer used. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-UnifiedGroup - - 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. - - String - - String - - - None - - - 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 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. - - ModernGroupTypeInfo - - ModernGroupTypeInfo - - - None - - - 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 value of Alias can contain letters, numbers and the following 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. - 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 (`<Alias>_<ExternalDirectoryObjectId>`). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Classification - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - ExecutingUser - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - ExoErrorAsWarning - - The ExoErrorAsWarning switch specifies that Exchange Online errors that you encounter while creating the Microsoft 365 Group are treated as warnings, not errors. You don't need to specify a value with this switch. - Creating Microsoft 365 Groups involves background operations in Azure Active Directory and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Azure Active Directory is synchronized back to Exchange Online. - - - SwitchParameter - - - 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 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. - - - SwitchParameter - - - False - - - Language - - The Language parameter specifies the language preference for the Microsoft 365 Group. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - ManagedBy - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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_<RandomGUID>`). Now, the value of the Name property is populated by the Alias parameter value and the ExternalDirectoryObjectId property value (`<Alias>_<ExternalDirectoryObjectId>`). - - String - - String - - - None - - - Notes - - The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - SuppressWarmupMessage - - This parameter has been deprecated and is no longer used. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-UnifiedGroup - - 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_<GUID>`. 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. - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - ExecutingUser - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - ManagedBy - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 ("). - 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. - - String - - String - - - None - - - 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_<GUID>`. 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. - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - 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 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. - - ModernGroupTypeInfo - - ModernGroupTypeInfo - - - None - - - 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 value of Alias can contain letters, numbers and the following 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. - 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 (`<Alias>_<ExternalDirectoryObjectId>`). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Classification - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - ExecutingUser - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - ExoErrorAsWarning - - The ExoErrorAsWarning switch specifies that Exchange Online errors that you encounter while creating the Microsoft 365 Group are treated as warnings, not errors. You don't need to specify a value with this switch. - Creating Microsoft 365 Groups involves background operations in Azure Active Directory and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Azure Active Directory is synchronized back to Exchange Online. - - SwitchParameter - - SwitchParameter - - - 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 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. - - SwitchParameter - - SwitchParameter - - - False - - - Language - - The Language parameter specifies the language preference for the Microsoft 365 Group. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - MailboxRegion - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - ManagedBy - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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_<RandomGUID>`). Now, the value of the Name property is populated by the Alias parameter value and the ExternalDirectoryObjectId property value (`<Alias>_<ExternalDirectoryObjectId>`). - - String - - String - - - None - - - Notes - - The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - SuppressWarmupMessage - - This parameter has been deprecated and is no longer used. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-UnifiedGroup -DisplayName "Engineering Department" -Alias "engineering" - - This example creates a new Microsoft 365 Group named Engineering Department. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-unifiedgroup - - - - - - Remove-AddressBookPolicy - Remove - AddressBookPolicy - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-AddressBookPolicy - - Identity - - The Identity parameter specifies the identity of the address book policy that you want to remove. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identity of the address book policy that you want to remove. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AddressBookPolicy -Identity "Murchison's Class" - - This example deletes the address book policy Murchison's Class. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-addressbookpolicy - - - - - - Remove-AddressList - Remove - AddressList - - This cmdlet is available in 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-AddressList cmdlet to remove existing address lists. - In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-AddressList - - Identity - - 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 - - Distinguished name (DN) - - GUID - - 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. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Recursive - - The Recursive switch specifies whether to remove all child address lists. You don't need to specify a value for this switch. - If you don't use this switch, and the address list has child address lists, the command will fail. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - Distinguished name (DN) - - GUID - - 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. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Recursive - - The Recursive switch specifies whether to remove all child address lists. You don't need to specify a value for this switch. - If you don't use this switch, and the address list has child address lists, the command will fail. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AddressList -Identity "AddressList1" -Recursive - - This example removes the address list named AddressList1 and all of its child address lists. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-addresslist - - - - - - Remove-AuthenticationPolicy - Remove - AuthenticationPolicy - - This cmdlet is available in 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-AuthenticationPolicy - - 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 - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AuthenticationPolicy -Identity "Engineering Group" - - This example removes the authentication policy named "Engineering Group". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-authenticationpolicy - - - - - - Remove-EmailAddressPolicy - Remove - EmailAddressPolicy - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Remove-EmailAddressPolicy cmdlet to remove existing email address policies and update the affected recipients. In Exchange Online, email address policies are only available for Microsoft 365 Groups. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-EmailAddressPolicy - - Identity - - 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 - - EmailAddressPolicyIdParameter - - EmailAddressPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - EmailAddressPolicyIdParameter - - EmailAddressPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-EmailAddressPolicy -Identity "Southwest Executives" - - This example removes the email address policy named Southwest Executives. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-emailaddresspolicy - - - - - - Remove-EOPDistributionGroup - Remove - EOPDistributionGroup - - This cmdlet is available only in Exchange Online Protection. - Use the Remove-EOPDistributionGroup cmdlet to delete distribution groups or mail-enabled security groups from standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Remove-DistributionGroup cmdlet instead. - Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-EOPDistributionGroup - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Identity - - The Identity parameter specifies the distribution group or mail-enabled security group that you want to remove. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Identity - - The Identity parameter specifies the distribution group or mail-enabled security group that you want to remove. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-EOPDistributionGroup -Identity "Security Team" - - This example removes the existing Exchange Online Protection distribution group named Security Team. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-eopdistributiongroup - - - - - - Remove-EOPMailUser - Remove - EOPMailUser - - This cmdlet is available only in Exchange Online Protection. - Use the Remove-EOPMailUser cmdlet to remove mail users, also known as mail-enabled users, from standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Remove-MailUser cmdlet instead. - Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-EOPMailUser - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Identity - - The Identity parameter specifies the mail user that you want to delete. You can use any value that uniquely identifies the mail user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailUserIdParameter - - MailUserIdParameter - - - None - - - - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Identity - - The Identity parameter specifies the mail user that you want to delete. You can use any value that uniquely identifies the mail user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailUserIdParameter - - MailUserIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-EOPMailUser -Identity "Ed Meadows" - - This example removes the mail-enabled user named Ed Meadows. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-eopmailuser - - - - - - Remove-GlobalAddressList - Remove - GlobalAddressList - - This cmdlet is available in 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-GlobalAddressList cmdlet to remove an existing global address list (GAL). - In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-GlobalAddressList - - Identity - - 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 - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-GlobalAddressList -Identity OldGAL - - This example removes the GAL named OldGAL. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-globaladdresslist - - - - - - Remove-HybridConfiguration - Remove - HybridConfiguration - - This cmdlet is available in 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-HybridConfiguration cmdlet to delete the HybridConfigurationActive Directory object for your on-premises Exchange organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Removing a HybridConfiguration object should typically only be performed in circumstances where the hybrid deployment state is corrupt and under the direction of Microsoft Customer Service and Support. After removing the HybridConfiguration object, your existing hybrid deployment configuration settings aren't disabled or removed. However, when the Hybrid Configuration wizard is run again after removing the HybridConfiguration object, the wizard won't have a hybrid configuration reference point for your existing feature settings. As a result, it will automatically create a HybridConfiguration object and record the new hybrid deployment configuration feature values defined in the wizard. The feature settings associated with the hybrid deployment, such as organization relationship or Send and Receive connector parameters, which were configured with the HybridConfiguration object that's removed, aren't removed or modified until the Hybrid Configuration wizard is run again. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-HybridConfiguration - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-HybridConfiguration - - This example removes the HybridConfiguration object for the hybrid deployment. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-hybridconfiguration - - - - - - Remove-Mailbox - Remove - Mailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-Mailbox - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Migration - - The Migration switch is required to remove migration mailboxes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Remove-Mailbox - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Migration - - The Migration switch is required to remove migration mailboxes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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). 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 3 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). - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Remove-Mailbox - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Migration - - The Migration switch is required to remove migration mailboxes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Migration - - The Migration switch is required to remove migration mailboxes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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). 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 3 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). - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 4 -------------------------- - Get-Mailbox -Identity Laura -SoftDeleted | Remove-Mailbox -PermanentlyDelete. - - In Exchange Online, this example removes the specified soft-deleted mailbox mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mailbox - - - - - - Remove-MailboxPermission - Remove - MailboxPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Remove-MailboxPermission cmdlet allows you to remove permissions from a user's mailbox, for example, removing full access to another user's mailbox. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MailboxPermission - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 - - MailboxRights[] - - MailboxRights[] - - - None - - - User - - The User parameter specifies the user mailbox that will get permissions removed. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Deny - - The Deny parameter denies permissions to the user on the Active Directory object. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - InheritanceType - - The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. - - ActiveDirectorySecurityInheritance - - ActiveDirectorySecurityInheritance - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Remove-MailboxPermission - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Remove-MailboxPermission - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - ClearAutoMapping - - This parameter is available or functional 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 <MailboxIdentity> -AccessRights FullAccess -AutoMapping $true`. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Remove-MailboxPermission - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Remove-MailboxPermission - - 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 - - MailboxIdParameter - - MailboxIdParameter - - - None - - - User - - The User parameter specifies the user mailbox that will get permissions removed. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Deny - - The Deny parameter denies permissions to the user on the Active Directory object. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - InheritanceType - - The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. - - ActiveDirectorySecurityInheritance - - ActiveDirectorySecurityInheritance - - - None - - - ResetDefault - - This parameter is available or functional 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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 - - MailboxRights[] - - MailboxRights[] - - - None - - - User - - The User parameter specifies the user mailbox that will get permissions removed. - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - ClearAutoMapping - - This parameter is available or functional 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 <MailboxIdentity> -AccessRights FullAccess -AutoMapping $true`. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Deny - - The Deny parameter denies permissions to the user on the Active Directory object. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - InheritanceType - - The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. - - ActiveDirectorySecurityInheritance - - ActiveDirectorySecurityInheritance - - - None - - - ResetDefault - - This parameter is available or functional 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mailboxpermission - - - - - - Remove-MailboxUserConfiguration - Remove - MailboxUserConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MailboxUserConfiguration - - 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. - - MailboxUserConfigurationIdParameter - - MailboxUserConfigurationIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - MailboxUserConfigurationIdParameter - - MailboxUserConfigurationIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 julia@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mailboxuserconfiguration - - - - - - Remove-MailContact - Remove - MailContact - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MailContact - - 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 - - MailContactIdParameter - - MailContactIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - MailContactIdParameter - - MailContactIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MailContact -Identity contoso.com/john - - This example removes the mail contact named John. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mailcontact - - - - - - Remove-MailUser - Remove - MailUser - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MailUser - - 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 - - MailUserIdParameter - - MailUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - MailUserIdParameter - - MailUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MailUser -Identity "Ed Meadows" - - This example removes the mail user named Ed Meadows. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-mailuser - - - - - - Remove-ManagementRole - Remove - ManagementRole - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to remove all the management role assignments from a role before you delete it. If the role is the parent of child roles, the child roles must be removed before you remove the parent role, or you must use the Recurse parameter when you remove the parent role. You can only remove custom roles. Built-in roles, such as the Mail Recipients role, can't be removed. For more information about how to remove a custom role, see Remove a role (https://docs.microsoft.com/exchange/remove-a-role-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ManagementRole - - Identity - - The Identity parameter specifies the custom role to remove. If the name of the role contains spaces, enclose the name in quotation marks ("). - - RoleIdParameter - - RoleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the custom role to remove. If the name of the role contains spaces, enclose the name in quotation marks ("). - - RoleIdParameter - - RoleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-managementrole - - - - - - Remove-ManagementRoleAssignment - Remove - ManagementRoleAssignment - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When you remove a role assignment, the management role group, management role assignment, user, or universal security group (USG) that was assigned the associated role can no longer access the cmdlets or parameters made available by the role. For more information about management role assignments, see Understanding management role assignments (https://docs.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ManagementRoleAssignment - - 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 ("). - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 ("). - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-managementroleassignment - - - - - - Remove-ManagementRoleEntry - Remove - ManagementRoleEntry - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Remove-ManagementRoleEntry cmdlet removes existing role entries. However, you can't remove role entries from built-in management roles. - For more information about management role entries, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ManagementRoleEntry - - Identity - - The Identity parameter specifies the role entry that you want to remove. This parameter uses the syntax: `<management role><role entry name>` (for example, `CustomRole\Set-Mailbox`). - For more information about how management role entries work, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - If the role entry name contains spaces, enclose the name in quotation marks ("). - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the role entry that you want to remove. This parameter uses the syntax: `<management role><role entry name>` (for example, `CustomRole\Set-Mailbox`). - For more information about how management role entries work, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - If the role entry name contains spaces, enclose the name in quotation marks ("). - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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\*" | Where-Object {$_.Name -like 'New-*'} | %{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 being piped to Remove-ManagementRoleEntry cmdlet. - This example forces you to acknowledge the command before proceeding. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-managementroleentry - - - - - - Remove-ManagementScope - Remove - ManagementScope - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can't remove a management scope if it's associated with a management role assignment. Use the Get-ManagementScope cmdlet to retrieve a list of orphaned scopes. For more information about regular and exclusive scopes, see Understanding management role scopes (https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ManagementScope - - 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. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-managementscope - - - - - - Remove-OfflineAddressBook - Remove - OfflineAddressBook - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If you remove the default OAB, you need to configure another OAB as the default by using the IsDefault parameter on the New-OfflineAddressBook or Set-OfflineAddressBook cmdlets. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-OfflineAddressBook - - 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 - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-OfflineAddressBook -Identity "\Contoso Executives" - - This example removes the OAB named Contoso Executives. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-offlineaddressbook - - - - - - Remove-OnPremisesOrganization - Remove - OnPremisesOrganization - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Removing an OnPremisesOrganization object should only be used in circumstances where the hybrid deployment state is corrupt and under the direction and supervision of Microsoft Customer Service and Support. After removing the OnPremisesOrganization object, any related hybrid deployment configured with this object won't be functional and will need to be re-created and reconfigured. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-OnPremisesOrganization - - Identity - - The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - - Canonical name - - GUID - - Name - - OnPremisesOrganizationIdParameter - - OnPremisesOrganizationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - - Canonical name - - GUID - - Name - - OnPremisesOrganizationIdParameter - - OnPremisesOrganizationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-OnPremisesOrganization -Identity ExchangeMail - - This example removes the ExchangeMail OnPremisesOrganization object in a Microsoft 365 organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-onpremisesorganization - - - - - - Remove-PartnerApplication - Remove - PartnerApplication - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the Remove-PartnerApplication cmdlet to remove a partner application configuration if the application no longer needs to access Exchange resources. For details, see Plan Exchange 2016 integration with SharePoint and Skype for Business (https://docs.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). - We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-PartnerApplication - - Identity - - The Identity parameter specifies the identity of the partner application. - - PartnerApplicationIdParameter - - PartnerApplicationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identity of the partner application. - - PartnerApplicationIdParameter - - PartnerApplicationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-PartnerApplication HRApp - - This command removes the HRApp partner application. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-partnerapplication - - - - - - Remove-RoleAssignmentPolicy - Remove - RoleAssignmentPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-RoleAssignmentPolicy - - Identity - - The Identity parameter specifies the assignment policy to remove. If the assignment policy name has spaces, enclose the name in quotation marks ("). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the assignment policy to remove. If the assignment policy name has spaces, enclose the name in quotation marks ("). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help) and [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-roleassignmentpolicy - - - - - - Remove-RoleGroup - Remove - RoleGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-RoleGroup - - Identity - - The Identity parameter specifies the role group to remove. If the role group name contains spaces, enclose the name in quotation marks ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the role group to remove. If the role group name contains spaces, enclose the name in quotation marks ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-rolegroup - - - - - - Remove-RoleGroupMember - Remove - RoleGroupMember - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-RoleGroupMember - - 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 ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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 ("). - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - 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 ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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 ("). - - SecurityPrincipalIdParameter - - SecurityPrincipalIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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: - - About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines)- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-rolegroupmember - - - - - - Remove-UnifiedGroup - Remove - UnifiedGroup - - 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 : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Microsoft 365 Groups are group objects that are available across Microsoft 365 services. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-UnifiedGroup - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-UnifiedGroup -Identity "Research Department" - - This example removes the Microsoft 365 Group named Research Department. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-unifiedgroup - - - - - - Remove-UnifiedGroupLinks - Remove - UnifiedGroupLinks - - 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 : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Microsoft 365 Groups are group objects that are available across Microsoft 365 services. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-UnifiedGroupLinks - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - Links - - The Links parameter specifies the recipients to remove from the Microsoft 365 Group. You specify whether these recipients are members, owners, or subscribers by using the LinkType parameter. - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - LinkType - - The LinkType parameter specifies the Microsoft 365 Group property that you want to modify. Valid values are: - - Aggregators - - Members - - Owners - - Subscribers - - LinkType - - LinkType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - Links - - The Links parameter specifies the recipients to remove from the Microsoft 365 Group. You specify whether these recipients are members, owners, or subscribers by using the LinkType parameter. - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - LinkType - - The LinkType parameter specifies the Microsoft 365 Group property that you want to modify. Valid values are: - - Aggregators - - Members - - Owners - - Subscribers - - LinkType - - LinkType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 Microsoft 365 Group named Legal Department. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-unifiedgrouplinks - - - - - - Remove-UserPhoto - Remove - UserPhoto - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-UserPhoto - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-UserPhoto "Ann Beebe" - - This example deletes the photo associated with Ann Beebe's user account. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-userphoto - - - - - - Set-AccessToCustomerDataRequest - Set - AccessToCustomerDataRequest - - This cmdlet is available only in the cloud-based service. - Use the Set-AccessToCustomerDataRequest cmdlet to approve, deny, or cancel Microsoft 365 customer lockbox requests that control access to your data by Microsoft support engineers. Note : Customer lockbox is included in the Microsoft 365 E5 plan. If you don't have a Microsoft 365 E5 plan, you can buy a separate customer lockbox subscription with any Microsoft 365 Enterprise plan. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AccessToCustomerDataRequest - - ApprovalDecision - - The ApprovalDecision parameter specifies the approval decision for the customer lockbox request. Valid values are: - - Approve - - Deny - - Cancel - - Approve | Deny | Cancel - - Approve | Deny | Cancel - - - None - - - RequestId - - The RequestId parameter specifies the reference number of the customer lockbox request that you want to approve, deny, or cancel (for example, EXSR123456). - - String - - String - - - None - - - 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". - - String - - String - - - None - - - - - - ApprovalDecision - - The ApprovalDecision parameter specifies the approval decision for the customer lockbox request. Valid values are: - - Approve - - Deny - - Cancel - - Approve | Deny | Cancel - - Approve | Deny | Cancel - - - None - - - RequestId - - The RequestId parameter specifies the reference number of the customer lockbox request that you want to approve, deny, or cancel (for example, EXSR123456). - - String - - String - - - None - - - 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". - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-accesstocustomerdatarequest - - - - - - Set-AddressBookPolicy - Set - AddressBookPolicy - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AddressBookPolicy - - Identity - - The Identity parameter specifies the identity of the address book policy that you want to modify. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - AddressListIdParameter[] - - AddressListIdParameter[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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. - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - RoomList - - The RoomList parameter specifies the name of the room address list. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identity of the address book policy that you want to modify. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - AddressListIdParameter[] - - AddressListIdParameter[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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. - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - RoomList - - The RoomList parameter specifies the name of the room address list. - - AddressListIdParameter - - AddressListIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-addressbookpolicy - - - - - - Set-AddressList - Set - AddressList - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AddressList - - 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"`) - - AddressListIdParameter - - AddressListIdParameter - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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"`) - - AddressListIdParameter - - AddressListIdParameter - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-addresslist - - - - - - Set-AuthenticationPolicy - Set - AuthenticationPolicy - - This cmdlet is available in 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AuthenticationPolicy - - 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 - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - AuthPolicyIdParameter - - AuthPolicyIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-authenticationpolicy - - - - - - Set-Contact - Set - Contact - - This cmdlet is available in 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-Contact cmdlet to modify contact object settings. If the contact is a mail contact, you can use the Set-MailContact cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Contact cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-Contact - - Identity - - The Identity parameter specifies the contact that you want to modify. You can use any value that uniquely identifies the contact. For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - ContactIdParameter - - ContactIdParameter - - - None - - - AllowUMCallsFromNonUsers - - The AllowUMCallsFromNonUsers parameter specifies whether to exclude the contact from directory searches. - - AllowUMCallsFromNonUsersFlags - - AllowUMCallsFromNonUsersFlags - - - None - - - AssistantName - - The AssistantName parameter specifies the name of the contact's assistant. - - String - - String - - - None - - - City - - The City parameter specifies the contact's city. - - String - - String - - - None - - - Company - - The Company parameter specifies the contact's company. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - CountryOrRegion - - 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. - - CountryInfo - - CountryInfo - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Department - - The Department parameter specifies the contact's department. - - String - - String - - - None - - - 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 meaningful only if the contact is mail-enabled. - - String - - String - - - None - - - Fax - - The Fax parameter specifies the contact's fax number. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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" - - GeoCoordinates - - GeoCoordinates - - - None - - - HomePhone - - The HomePhone parameter specifies the contact's home telephone number. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - Manager - - The Manager parameter specifies the contact's manager. - - UserContactIdParameter - - UserContactIdParameter - - - None - - - MobilePhone - - The MobilePhone parameter specifies the contact's primary mobile phone number. - - String - - String - - - None - - - Name - - The Name parameter specifies the unique name of the contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - OtherFax - - The OtherFax parameter specifies the contact's alternative fax number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OtherHomePhone - - The OtherHomePhone parameter specifies the contact's alternative home telephone number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OtherTelephone - - The OtherTelephone parameter specifies the contact's alternative office telephone number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Pager - - The Pager parameter specifies the contact's pager number. - - String - - String - - - None - - - Phone - - The Phone parameter specifies the contact's office telephone number. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - PostalCode - - The PostalCode parameter specifies the contact's postal code. - - String - - String - - - None - - - PostOfficeBox - - The PostOfficeBox parameter specifies the contact's post office box number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SeniorityIndex - - The SeniorityIndex parameter specifies the order in which this contact will display in a hierarchical address book. A contact with a value of 2 will display higher in an address book than a contact with a value of 1. - - Int32 - - Int32 - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - This parameter is meaningful only if the contact is mail-enabled. - - String - - String - - - None - - - StateOrProvince - - The StateOrProvince parameter specifies the contact's state or province. - - String - - String - - - None - - - StreetAddress - - The StreetAddress parameter specifies the contact's physical address. - - String - - String - - - None - - - TelephoneAssistant - - The TelephoneAssistant parameter specifies the telephone number of the contact's assistant. - - String - - String - - - None - - - Title - - The Title parameter specifies the contact's title. - - String - - String - - - None - - - UMCallingLineIds - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WebPage - - The WebPage parameter specifies the contact's web page. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - Identity - - The Identity parameter specifies the contact that you want to modify. You can use any value that uniquely identifies the contact. For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - ContactIdParameter - - ContactIdParameter - - - None - - - AllowUMCallsFromNonUsers - - The AllowUMCallsFromNonUsers parameter specifies whether to exclude the contact from directory searches. - - AllowUMCallsFromNonUsersFlags - - AllowUMCallsFromNonUsersFlags - - - None - - - AssistantName - - The AssistantName parameter specifies the name of the contact's assistant. - - String - - String - - - None - - - City - - The City parameter specifies the contact's city. - - String - - String - - - None - - - Company - - The Company parameter specifies the contact's company. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - CountryOrRegion - - 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. - - CountryInfo - - CountryInfo - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Department - - The Department parameter specifies the contact's department. - - String - - String - - - None - - - 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 meaningful only if the contact is mail-enabled. - - String - - String - - - None - - - Fax - - The Fax parameter specifies the contact's fax number. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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" - - GeoCoordinates - - GeoCoordinates - - - None - - - HomePhone - - The HomePhone parameter specifies the contact's home telephone number. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - Manager - - The Manager parameter specifies the contact's manager. - - UserContactIdParameter - - UserContactIdParameter - - - None - - - MobilePhone - - The MobilePhone parameter specifies the contact's primary mobile phone number. - - String - - String - - - None - - - Name - - The Name parameter specifies the unique name of the contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - OtherFax - - The OtherFax parameter specifies the contact's alternative fax number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OtherHomePhone - - The OtherHomePhone parameter specifies the contact's alternative home telephone number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OtherTelephone - - The OtherTelephone parameter specifies the contact's alternative office telephone number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Pager - - The Pager parameter specifies the contact's pager number. - - String - - String - - - None - - - Phone - - The Phone parameter specifies the contact's office telephone number. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - PostalCode - - The PostalCode parameter specifies the contact's postal code. - - String - - String - - - None - - - PostOfficeBox - - The PostOfficeBox parameter specifies the contact's post office box number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SeniorityIndex - - The SeniorityIndex parameter specifies the order in which this contact will display in a hierarchical address book. A contact with a value of 2 will display higher in an address book than a contact with a value of 1. - - Int32 - - Int32 - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - This parameter is meaningful only if the contact is mail-enabled. - - String - - String - - - None - - - StateOrProvince - - The StateOrProvince parameter specifies the contact's state or province. - - String - - String - - - None - - - StreetAddress - - The StreetAddress parameter specifies the contact's physical address. - - String - - String - - - None - - - TelephoneAssistant - - The TelephoneAssistant parameter specifies the telephone number of the contact's assistant. - - String - - String - - - None - - - Title - - The Title parameter specifies the contact's title. - - String - - String - - - None - - - UMCallingLineIds - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WebPage - - The WebPage parameter specifies the contact's web page. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-Contact -Identity "contoso.com/Users/Arlene Huff" -City "Seattle" -Company "Contoso" - - This example makes the following changes to the existing contact named Arlene Huff in the Users container in the Active Directory domain contoso.com: - Change the City parameter value to Seattle. - Change the Company parameter value to Contoso. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-contact - - - - - - Set-EmailAddressPolicy - Set - EmailAddressPolicy - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Set-EmailAddressPolicy cmdlet to modify email address policies. In Exchange Online, email address policies are only available for Microsoft 365 Groups. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-EmailAddressPolicy - - 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 - - EmailAddressPolicyIdParameter - - EmailAddressPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. - AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - 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. - - ProxyAddressTemplateCollection - - ProxyAddressTemplateCollection - - - None - - - 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 Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - EmailAddressPolicyPriority - - EmailAddressPolicyPriority - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - EmailAddressPolicyIdParameter - - EmailAddressPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. - AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - 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. - - ProxyAddressTemplateCollection - - ProxyAddressTemplateCollection - - - None - - - 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 Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - EmailAddressPolicyPriority - - EmailAddressPolicyPriority - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 3 -------------------------- - Set-EmailAddressPolicy -Identity "Office 365 Groups" -EnabledEmailAddressTemplates "SMTP:@contoso.com","smtp:@contoso.onmicrosoft.com","smtp:@contoso.microsoftonline.com" - - In Exchange Online, this example modifies the existing email adress policy named "Office 365 Groups" and sets the enabled email address templates to use "@contoso.com" as the primary SMTP address and "@contoso.onmicrosoft.com" and "@contoso.microsoftonline.com" as proxy addresses. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-emailaddresspolicy - - - - - - Set-EOPDistributionGroup - Set - EOPDistributionGroup - - This cmdlet is available only in Exchange Online Protection. - Use the Set-EOPDistributionGroup cmdlet to modify distribution groups or mail-enabled security groups in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-DistributionGroup cmdlet instead. - Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-EOPDistributionGroup - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - Alias - - The Alias parameter specifies the alias of the distribution group. - The value of Alias can contain letters, numbers and the following 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. - - String - - String - - - None - - - DisplayName - - The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC). - - String - - String - - - None - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - ManagedBy - - The ManagedBy parameter specifies one or more group owners. A group must have at least one owner. You can use any value that uniquely identifies the owner. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. - The users specified with the ManagedBy parameter aren't automatically members of the distribution group. If you want any of the owners to be added as members of the distribution group, you need to add them by using the Update-EOPDistributionGroupMember cmdlet. - - String[] - - String[] - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - - SmtpAddress - - SmtpAddress - - - None - - - - - - 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 - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - Alias - - The Alias parameter specifies the alias of the distribution group. - The value of Alias can contain letters, numbers and the following 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. - - String - - String - - - None - - - DisplayName - - The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC). - - String - - String - - - None - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - ManagedBy - - The ManagedBy parameter specifies one or more group owners. A group must have at least one owner. You can use any value that uniquely identifies the owner. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. - The users specified with the ManagedBy parameter aren't automatically members of the distribution group. If you want any of the owners to be added as members of the distribution group, you need to add them by using the Update-EOPDistributionGroupMember cmdlet. - - String[] - - String[] - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-eopdistributiongroup - - - - - - Set-EOPGroup - Set - EOPGroup - - This cmdlet is available only in Exchange Online Protection. - Use the Set-EOPGroup cmdlet to modify general group object attributes in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-Group cmdlet instead. - Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-EOPGroup - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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 - - GroupIdParameter - - GroupIdParameter - - - None - - - ManagedBy - - The ManagedBy parameter specifies a user who owns the group. You can use any value that uniquely identifies the user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. - The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - - String[] - - String[] - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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 - - GroupIdParameter - - GroupIdParameter - - - None - - - ManagedBy - - The ManagedBy parameter specifies a user who owns the group. You can use any value that uniquely identifies the user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. - The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - - String[] - - String[] - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-eopgroup - - - - - - Set-EOPMailUser - Set - EOPMailUser - - This cmdlet is available only in Exchange Online Protection. - Use the Set-EOPMailUser cmdlet to modify mail users, also known as mail-enabled users, in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-MailUser cmdlet instead. - Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-EOPMailUser - - Identity - - The Identity parameter specifies the mail user that you want to modify. You can use any value that uniquely identifies the mail user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailUserIdParameter - - MailUserIdParameter - - - None - - - Alias - - The Alias parameter specifies the alias of the mail user. - The value of Alias can contain letters, numbers and the following 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. - - String - - String - - - None - - - DisplayName - - The DisplayName parameter specifies the display name of the mail user in the Exchange admin center (EAC). - - String - - String - - - None - - - 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. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - MicrosoftOnlineServicesID - - The MicrosoftOnlineServicesID parameter specifies the user account for the mail user. - - SmtpAddress - - SmtpAddress - - - None - - - Password - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - - - - Identity - - The Identity parameter specifies the mail user that you want to modify. You can use any value that uniquely identifies the mail user. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailUserIdParameter - - MailUserIdParameter - - - None - - - Alias - - The Alias parameter specifies the alias of the mail user. - The value of Alias can contain letters, numbers and the following 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. - - String - - String - - - None - - - DisplayName - - The DisplayName parameter specifies the display name of the mail user in the Exchange admin center (EAC). - - String - - String - - - None - - - 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. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - MicrosoftOnlineServicesID - - The MicrosoftOnlineServicesID parameter specifies the user account for the mail user. - - SmtpAddress - - SmtpAddress - - - None - - - Password - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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." - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-eopmailuser - - - - - - Set-EOPUser - Set - EOPUser - - This cmdlet is available only in Exchange Online Protection. - Use the Set-EOPUser cmdlet to modify general user object attributes in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-User cmdlet instead. - Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-EOPUser - - Identity - - The Identity parameter specifies the user object that you want to modify. You can use any value that uniquely identifies the user. For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - UserIdParameter - - UserIdParameter - - - None - - - City - - The City parameter specifies the user's city. - - String - - String - - - None - - - Company - - The Company parameter specifies the user's company. - - String - - String - - - None - - - 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. - - CountryInfo - - CountryInfo - - - None - - - Department - - The Department parameter specifies the user's department. - - String - - String - - - None - - - DisplayName - - The DisplayName parameter specifies the user's display name. - - String - - String - - - None - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Fax - - The Fax parameter specifies the user's fax number. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - HomePhone - - The HomePhone parameter specifies the user's home telephone number. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - MobilePhone - - The MobilePhone parameter specifies the user's primary mobile phone number. - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - Phone - - The Phone parameter specifies the user's telephone number. - - String - - String - - - None - - - PostalCode - - The PostalCode parameter specifies the user's zip code or postal code. - - String - - String - - - None - - - StateOrProvince - - The StateOrProvince parameter specifies the user's state or province. - - String - - String - - - None - - - StreetAddress - - The StreetAddress parameter specifies the user's physical address. - - String - - String - - - None - - - Title - - The Title parameter specifies the user's title. - - String - - String - - - None - - - WebPage - - The WebPage parameter specifies the user's Web page. - - String - - String - - - None - - - - - - Identity - - The Identity parameter specifies the user object that you want to modify. You can use any value that uniquely identifies the user. For example: - - Name - - Distinguished name (DN) - - Canonical DN - - GUID - - UserIdParameter - - UserIdParameter - - - None - - - City - - The City parameter specifies the user's city. - - String - - String - - - None - - - Company - - The Company parameter specifies the user's company. - - String - - String - - - None - - - 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. - - CountryInfo - - CountryInfo - - - None - - - Department - - The Department parameter specifies the user's department. - - String - - String - - - None - - - DisplayName - - The DisplayName parameter specifies the user's display name. - - String - - String - - - None - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Fax - - The Fax parameter specifies the user's fax number. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - HomePhone - - The HomePhone parameter specifies the user's home telephone number. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - MobilePhone - - The MobilePhone parameter specifies the user's primary mobile phone number. - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - Phone - - The Phone parameter specifies the user's telephone number. - - String - - String - - - None - - - PostalCode - - The PostalCode parameter specifies the user's zip code or postal code. - - String - - String - - - None - - - StateOrProvince - - The StateOrProvince parameter specifies the user's state or province. - - String - - String - - - None - - - StreetAddress - - The StreetAddress parameter specifies the user's physical address. - - String - - String - - - None - - - Title - - The Title parameter specifies the user's title. - - String - - String - - - None - - - WebPage - - The WebPage parameter specifies the user's Web page. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-eopuser - - - - - - Set-EventsFromEmailConfiguration - Set - EventsFromEmailConfiguration - - This cmdlet is only available in the cloud-based service. - Use the Set-EventsFromEmailConfiguration cmdlet to modify the events from email settings on a mailbox. on Outlook clients and Outlook on the web. These settings define whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to the user's calendar. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-EventsFromEmailConfiguration - - Identity - - The Identity parameter specifies the mailbox that you want to modify. You identify the mailbox by email address. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EventReservationProcessingLevel - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - FoodEstablishmentReservationProcessingLevel - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - InvoiceProcessingLevel - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - ServiceReservationProcessingLevel - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - - Set-EventsFromEmailConfiguration - - Identity - - The Identity parameter specifies the mailbox that you want to modify. You identify the mailbox by email address. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the mailbox that you want to modify. You identify the mailbox by email address. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EventReservationProcessingLevel - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - FoodEstablishmentReservationProcessingLevel - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - InvoiceProcessingLevel - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ServiceReservationProcessingLevel - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-EventsFromEmailConfiguration -Identity peter@contoso.com -InvoiceProgressingLevel Disabled - - This example disables the discovery of invoices from messages for the user. - - - - -------------------------- Example 2 -------------------------- - 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 -------------------------- - Set-EventsFromEmailConfiguration -Identity peter@contoso.com -ResetSettings - - This example resets Events from Email settings for the user. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-eventsfromemailconfiguration - - - - - - Set-GlobalAddressList - Set - GlobalAddressList - - This cmdlet is available in 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://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-GlobalAddressList - - 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 - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - GlobalAddressListIdParameter - - GlobalAddressListIdParameter - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - WellKnownRecipientType - - WellKnownRecipientType - - - None - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales '` is allowed, but `' Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales '` or `' Sales'` are allowed, but `'Sa*les'` isn't allowed. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-globaladdresslist - - - - - - Set-LinkedUser - Set - LinkedUser - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The OLSync service account is the only linked user in your organization. By default, the account is named GALSync-ServiceAccount. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-LinkedUser - - 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) - - UserIdParameter - - UserIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - UserIdParameter - - UserIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-linkeduser - - - - - - Set-Mailbox - Set - Mailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use this cmdlet for one mailbox at a time. To perform bulk management, you can pipeline the output of various Get- cmdlets (for example, the Get-Mailbox or Get-User cmdlets) and configure several mailboxes in a single-line command. You can also use the Set-Mailbox cmdlet in scripts. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-Mailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AccountDisabled - - This parameter is available o 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - AddressBookMailboxPolicyIdParameter - - AddressBookMailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ArchiveStatus - - This parameter is reserved for internal Microsoft use. - - ArchiveStatusFlags - - ArchiveStatusFlags - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. - 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. - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ExternalOofOptions - - ExternalOofOptions - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - Languages - - The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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`. - - Int32 - - Int32 - - - None - - - 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`. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 <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>`. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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: - - Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). - On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 Server (https://docs.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 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - RoomMailboxPassword - - Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - StsRefreshTokensValidFrom - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - Type - - The Type parameter specifies the mailbox type for the mailbox. Valid values are: - - Equipment - - Regular - - Room - - Shared - - Workspace (cloud-only) - - ConvertibleMailboxSubType - - ConvertibleMailboxSubType - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserCertificate - - The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - Set-Mailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AccountDisabled - - This parameter is available o 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - AddressBookMailboxPolicyIdParameter - - AddressBookMailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. - 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. - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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). - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ExternalOofOptions - - ExternalOofOptions - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - GroupMailbox - - This parameter is available only in the cloud-based service. - The GroupMailbox switch is required to modify Group Mailboxes in Exchange Online. You don't need to specify a value with this switch. - You can use any value that uniquely identifies the Group Mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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 | 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - Languages - - The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 <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>`. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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: - - Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). - On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - ProvisionedForOfficeGraph - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 Server (https://docs.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 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - RoomMailboxPassword - - Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - StsRefreshTokensValidFrom - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - Type - - The Type parameter specifies the mailbox type for the mailbox. Valid values are: - - Equipment - - Regular - - Room - - Shared - - Workspace (cloud-only) - - ConvertibleMailboxSubType - - ConvertibleMailboxSubType - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserCertificate - - The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - Set-Mailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AccountDisabled - - This parameter is available o 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - AddressBookMailboxPolicyIdParameter - - AddressBookMailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. - 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. - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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). - - String[] - - String[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ExternalOofOptions - - ExternalOofOptions - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - GroupMailbox - - This parameter is available only in the cloud-based service. - The GroupMailbox switch is required to modify Group Mailboxes in Exchange Online. You don't need to specify a value with this switch. - You can use any value that uniquely identifies the Group Mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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 | 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - Languages - - The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 <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>`. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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: - - Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). - On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - ProvisionedForOfficeGraph - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 Server (https://docs.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 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - RoomMailboxPassword - - Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - StsRefreshTokensValidFrom - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - Type - - The Type parameter specifies the mailbox type for the mailbox. Valid values are: - - Equipment - - Regular - - Room - - Shared - - Workspace (cloud-only) - - ConvertibleMailboxSubType - - ConvertibleMailboxSubType - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserCertificate - - The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - Set-Mailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AccountDisabled - - This parameter is available o 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - AddressBookMailboxPolicyIdParameter - - AddressBookMailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. - 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. - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ExternalOofOptions - - ExternalOofOptions - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - GroupMailbox - - This parameter is available only in the cloud-based service. - The GroupMailbox switch is required to modify Group Mailboxes in Exchange Online. You don't need to specify a value with this switch. - You can use any value that uniquely identifies the Group Mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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 | 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - Languages - - The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 <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>`. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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: - - Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). - On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - ProvisionedForOfficeGraph - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 Server (https://docs.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 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - RoomMailboxPassword - - Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - StsRefreshTokensValidFrom - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - Type - - The Type parameter specifies the mailbox type for the mailbox. Valid values are: - - Equipment - - Regular - - Room - - Shared - - Workspace (cloud-only) - - ConvertibleMailboxSubType - - ConvertibleMailboxSubType - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserCertificate - - The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - Set-Mailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AccountDisabled - - This parameter is available o 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - AddressBookMailboxPolicyIdParameter - - AddressBookMailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. - 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. - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ExternalOofOptions - - ExternalOofOptions - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - GroupMailbox - - This parameter is available only in the cloud-based service. - The GroupMailbox switch is required to modify Group Mailboxes in Exchange Online. You don't need to specify a value with this switch. - You can use any value that uniquely identifies the Group Mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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 | 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - Languages - - The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 <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>`. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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: - - Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). - On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - ProvisionedForOfficeGraph - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 `<MailboxIdentity>` with the name, email address, or alias of the mailbox, and run this command: `Export-MailboxDiagnosticLogs -Identity <MailboxIdentity> -ComponentName HoldTracking`. - You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. For more information, see Managing mailboxes on delay hold (https://docs.microsoft.com/microsoft-365/compliance/identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 Server (https://docs.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 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - RoomMailboxPassword - - Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - StsRefreshTokensValidFrom - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - Type - - The Type parameter specifies the mailbox type for the mailbox. Valid values are: - - Equipment - - Regular - - Room - - Shared - - Workspace (cloud-only) - - ConvertibleMailboxSubType - - ConvertibleMailboxSubType - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserCertificate - - The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - Set-Mailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AccountDisabled - - This parameter is available o 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - AddressBookMailboxPolicyIdParameter - - AddressBookMailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. - 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. - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ExternalOofOptions - - ExternalOofOptions - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - GroupMailbox - - This parameter is available only in the cloud-based service. - The GroupMailbox switch is required to modify Group Mailboxes in Exchange Online. You don't need to specify a value with this switch. - You can use any value that uniquely identifies the Group Mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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 | 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - Languages - - The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 <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>`. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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: - - Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). - On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - ProvisionedForOfficeGraph - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveDelayReleaseHoldApplied - - This parameter is available only in the cloud-based service. - The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Yammer) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. - The 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 SubstrateHoldTracking`. - You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. - For more information, see Managing mailboxes on delay hold (https://docs.microsoft.com/microsoft-365/compliance/identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 Server (https://docs.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 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - RoomMailboxPassword - - Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - StsRefreshTokensValidFrom - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - Type - - The Type parameter specifies the mailbox type for the mailbox. Valid values are: - - Equipment - - Regular - - Room - - Shared - - Workspace (cloud-only) - - ConvertibleMailboxSubType - - ConvertibleMailboxSubType - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserCertificate - - The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - Set-Mailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AccountDisabled - - This parameter is available o 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - AddressBookMailboxPolicyIdParameter - - AddressBookMailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. - 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. - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ExternalOofOptions - - ExternalOofOptions - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - GroupMailbox - - This parameter is available only in the cloud-based service. - The GroupMailbox switch is required to modify Group Mailboxes in Exchange Online. You don't need to specify a value with this switch. - You can use any value that uniquely identifies the Group Mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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 | 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - Languages - - The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 <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>`. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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: - - Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). - On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - ProvisionedForOfficeGraph - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 Server (https://docs.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 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - RoomMailboxPassword - - Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - StsRefreshTokensValidFrom - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - Type - - The Type parameter specifies the mailbox type for the mailbox. Valid values are: - - Equipment - - Regular - - Room - - Shared - - Workspace (cloud-only) - - ConvertibleMailboxSubType - - ConvertibleMailboxSubType - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserCertificate - - The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - Set-Mailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AccountDisabled - - This parameter is available o 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - AddressBookMailboxPolicyIdParameter - - AddressBookMailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. - 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. - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ExternalOofOptions - - ExternalOofOptions - - - None - - - 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. - - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - GroupMailbox - - This parameter is available only in the cloud-based service. - The GroupMailbox switch is required to modify Group Mailboxes in Exchange Online. You don't need to specify a value with this switch. - You can use any value that uniquely identifies the Group Mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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 | 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - Languages - - The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 <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>`. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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: - - Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). - On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - ProvisionedForOfficeGraph - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String[] - - String[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 Server (https://docs.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 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - RoomMailboxPassword - - Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - StsRefreshTokensValidFrom - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - Type - - The Type parameter specifies the mailbox type for the mailbox. Valid values are: - - Equipment - - Regular - - Room - - Shared - - Workspace (cloud-only) - - ConvertibleMailboxSubType - - ConvertibleMailboxSubType - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserCertificate - - The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AccountDisabled - - This parameter is available o 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). - - AddressBookMailboxPolicyIdParameter - - AddressBookMailboxPolicyIdParameter - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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>`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ArchiveStatus - - This parameter is reserved for internal Microsoft use. - - ArchiveStatusFlags - - ArchiveStatusFlags - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - Boolean - - Boolean - - - None - - - 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). - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. - 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. - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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). - - SwitchParameter - - SwitchParameter - - - 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). - - String[] - - String[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ExternalOofOptions - - ExternalOofOptions - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - GroupMailbox - - This parameter is available only in the cloud-based service. - The GroupMailbox switch is required to modify Group Mailboxes in Exchange Online. You don't need to specify a value with this switch. - You can use any value that uniquely identifies the Group Mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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 | 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - Languages - - The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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`. - - Int32 - - Int32 - - - None - - - 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`. - - Int32 - - Int32 - - - None - - - 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://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 <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>`. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - 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: - - Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). - On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - 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 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. - - Unlimited - - Unlimited - - - None - - - ProvisionedForOfficeGraph - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 `<MailboxIdentity>` with the name, email address, or alias of the mailbox, and run this command: `Export-MailboxDiagnosticLogs -Identity <MailboxIdentity> -ComponentName HoldTracking`. - You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. For more information, see Managing mailboxes on delay hold (https://docs.microsoft.com/microsoft-365/compliance/identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). - - SwitchParameter - - SwitchParameter - - - False - - - RemoveDelayReleaseHoldApplied - - This parameter is available only in the cloud-based service. - The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Yammer) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. - The 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 SubstrateHoldTracking`. - You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. - For more information, see Managing mailboxes on delay hold (https://docs.microsoft.com/microsoft-365/compliance/identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String[] - - String[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 Server (https://docs.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 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - RoomMailboxPassword - - Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - - SecureString - - SecureString - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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. - - SharingPolicyIdParameter - - SharingPolicyIdParameter - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - DateTime - - DateTime - - - None - - - StsRefreshTokensValidFrom - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - Type - - The Type parameter specifies the mailbox type for the mailbox. Valid values are: - - Equipment - - Regular - - Room - - Shared - - Workspace (cloud-only) - - ConvertibleMailboxSubType - - ConvertibleMailboxSubType - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserCertificate - - The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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}. - - - - -------------------------- Example 7 -------------------------- - Set-Mailbox -Identity "John Woods" -EmailAddresses @{add="Jwoods@contoso.com"} - - This example adds a secondary email address to John's mailbox. - - - - -------------------------- Example 8 -------------------------- - Set-Mailbox -Identity asraf@contoso.com -RemoveDelayReleaseHoldApplied - - In Exchange Online, this example removes the delay hold that's applied to Asraf's mailbox so an offboarding migration (that is, a mailbox migration from Exchange Online back to on-premises Exchange) can continue successfully. For more information about delay holds, see Managing mailboxes on delay hold (https://docs.microsoft.com/microsoft-365/compliance/identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). - - - - -------------------------- Example 9 -------------------------- - Set-Mailbox -Identity asraf@contoso.com -NonCompliantDevices @("{'DeviceId':'8d5e5aa2-951d-4738-b727-d4b440a81467','DeviceNonCompliantAfter':'2021-05-08T06:57:27.0891574Z','EnforcedEventType':1}", "{'DeviceId':'8d5e5aa2-951d-4738-b727-d4b440a81777','DeviceNonCompliantAfter':'2023-05-09T06:57:27.0891574Z','EnforcedEventType':'1'}") - - This example sets the noncompliant devices property of a mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailbox - - - - - - Set-MailboxAutoReplyConfiguration - Set - MailboxAutoReplyConfiguration - - This cmdlet is available in 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-MailboxAutoReplyConfiguration cmdlet to configure Automatic Replies settings for a specific mailbox. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can disable Automatic Replies for a specified mailbox or organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxAutoReplyConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - AutoDeclineFutureRequestsWhenOOF - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - AutoReplyState - - 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. - - OofState - - OofState - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - CreateOOFEvent - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - DeclineAllEventsForScheduledOOF - - This parameter is available or 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. - - $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. - You can't use this parameter with the EventsToDeleteIDs parameter. - - Boolean - - Boolean - - - None - - - DeclineEventsForScheduledOOF - - This parameter is available or 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. - - $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. - - Boolean - - Boolean - - - None - - - DeclineMeetingMessage - - This parameter is available or 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, `"<html><body>I'm on vacation. <b>I can't attend the meeting.</b></body></html>"`. - To clear the value of this parameter, use the value $null. - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - EventsToDeleteIDs - - This parameter is available or 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. - You can specify multiple calendar events separated by commas. - You can't use this parameter with the DeclineAllEventsForScheduledOOF parameter. - - String[] - - String[] - - - None - - - ExternalAudience - - 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. - - ExternalAudience - - ExternalAudience - - - None - - - 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: `<html><body>I'm on vacation</body></html>`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"<html><body><b>I'm on vacation</b>. I'll respond when I return.</body></html>"`. - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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: `<html><body>I'm on vacation</body></html>`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"<html><body>I'm on vacation. <b>Please contact my manager.</b></body></html>"`. - The value of this parameter is meaningful only when the AutoReplyState parameter is set to Enabled or Scheduled. - To clear the value of this parameter when it's no longer required (for example, if you change the AutoReplyState parameter to Disabled), use the value $null. - - String - - String - - - None - - - OOFEventSubject - - This parameter is available or 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. - If the value contains spaces, enclose the value in quotation marks ("). To clear the value of this parameter, use the value $null. - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - AutoDeclineFutureRequestsWhenOOF - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - AutoReplyState - - 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. - - OofState - - OofState - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - CreateOOFEvent - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - DeclineAllEventsForScheduledOOF - - This parameter is available or 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. - - $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. - You can't use this parameter with the EventsToDeleteIDs parameter. - - Boolean - - Boolean - - - None - - - DeclineEventsForScheduledOOF - - This parameter is available or 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. - - $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. - - Boolean - - Boolean - - - None - - - DeclineMeetingMessage - - This parameter is available or 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, `"<html><body>I'm on vacation. <b>I can't attend the meeting.</b></body></html>"`. - To clear the value of this parameter, use the value $null. - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - EventsToDeleteIDs - - This parameter is available or 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. - You can specify multiple calendar events separated by commas. - You can't use this parameter with the DeclineAllEventsForScheduledOOF parameter. - - String[] - - String[] - - - None - - - ExternalAudience - - 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. - - ExternalAudience - - ExternalAudience - - - None - - - 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: `<html><body>I'm on vacation</body></html>`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"<html><body><b>I'm on vacation</b>. I'll respond when I return.</body></html>"`. - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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: `<html><body>I'm on vacation</body></html>`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"<html><body>I'm on vacation. <b>Please contact my manager.</b></body></html>"`. - The value of this parameter is meaningful only when the AutoReplyState parameter is set to Enabled or Scheduled. - To clear the value of this parameter when it's no longer required (for example, if you change the AutoReplyState parameter to Disabled), use the value $null. - - String - - String - - - None - - - OOFEventSubject - - This parameter is available or 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. - If the value contains spaces, enclose the value in quotation marks ("). To clear the value of this parameter, use the value $null. - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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" - - This example configures Automatic Replies for Tony's mailbox to be sent between the specified start and end dates and includes an internal message. - - - - -------------------------- Example 2 -------------------------- - Set-MailboxAutoReplyConfiguration -Identity tony -AutoReplyState Enabled -InternalMessage "Internal auto-reply message." -ExternalMessage "External auto-reply message." - - This example configures Automatic Replies for Tony's mailbox to be sent and includes an internal and an external message. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxautoreplyconfiguration - - - - - - Set-MailboxCalendarConfiguration - Set - MailboxCalendarConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxCalendarConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - AgendaMailEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - AgendaPaneEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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). - - String - - String - - - None - - - 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). - - String - - String - - - None - - - CalendarFeedsRootPageId - - This parameter is available only in the cloud-based service. - The CalendarFeedsRootPageId parameter specifies the root page ID for calendar feeds. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - DailyAgendaMailSchedule - - This parameter is reserved for internal Microsoft use. - - AgendaMailSchedule - - AgendaMailSchedule - - - None - - - DefaultMeetingDuration - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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 - - Boolean - - Boolean - - - True - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - FirstWeekRules - - FirstWeekRules - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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: The value of the OnlineMeetingsByDefaultEnabled parameter on the Set-OrganizationConfig cmdlet (the organizational setting) is used. - - System.Boolean - - System.Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SkipAgendaMailOnFreeDays - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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) - - HourIncrement - - HourIncrement - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - DayOfWeek - - DayOfWeek - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"`. - 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:<LocationID>;Name:<Name>;Latitude:<Latitude>;Longitude:<Longitude>`. - You can configure a maximum of 5 weather locations. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - WeatherTemperatureUnit - - WeatherTemperatureUnit - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - DaysOfWeek - - DaysOfWeek - - - None - - - 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.). - - TimeSpan - - TimeSpan - - - None - - - 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.). - - TimeSpan - - TimeSpan - - - None - - - 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. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - AgendaMailEnabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - AgendaPaneEnabled - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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). - - String - - String - - - None - - - 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). - - String - - String - - - None - - - CalendarFeedsRootPageId - - This parameter is available only in the cloud-based service. - The CalendarFeedsRootPageId parameter specifies the root page ID for calendar feeds. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - DailyAgendaMailSchedule - - This parameter is reserved for internal Microsoft use. - - AgendaMailSchedule - - AgendaMailSchedule - - - None - - - DefaultMeetingDuration - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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 - - Boolean - - Boolean - - - True - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - FirstWeekRules - - FirstWeekRules - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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: The value of the OnlineMeetingsByDefaultEnabled parameter on the Set-OrganizationConfig cmdlet (the organizational setting) is used. - - System.Boolean - - System.Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SkipAgendaMailOnFreeDays - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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) - - HourIncrement - - HourIncrement - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - DayOfWeek - - DayOfWeek - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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"`. - 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:<LocationID>;Name:<Name>;Latitude:<Latitude>;Longitude:<Longitude>`. - You can configure a maximum of 5 weather locations. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - WeatherTemperatureUnit - - WeatherTemperatureUnit - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - DaysOfWeek - - DaysOfWeek - - - None - - - 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.). - - TimeSpan - - TimeSpan - - - None - - - 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.). - - TimeSpan - - TimeSpan - - - None - - - 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. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxcalendarconfiguration - - - - - - Set-MailboxJunkEmailConfiguration - Set - MailboxJunkEmailConfiguration - - This cmdlet is available in 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 SilentlyContinue to the end of the command. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-antispam-settings). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxJunkEmailConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 -Identity <MailboxIdentity>` - - On-premises Exchange only: `Get-InboxRule "Junk E-mail Rule" -Mailbox <MailboxIdentity> -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). - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - TrustedRecipientsAndDomains - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 : - - 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 KB3019657 (https://support.microsoft.com/help/3019657). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 -Identity <MailboxIdentity>` - - On-premises Exchange only: `Get-InboxRule "Junk E-mail Rule" -Mailbox <MailboxIdentity> -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). - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - TrustedRecipientsAndDomains - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 : - - 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 KB3019657 (https://support.microsoft.com/help/3019657). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxjunkemailconfiguration - - - - - - Set-MailboxMessageConfiguration - Set - MailboxMessageConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxMessageConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - AfterMoveOrDeleteBehavior - - AfterMoveOrDeleteBehavior - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - ConversationSortOrder - - ConversationSortOrder - - - None - - - 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. - - String - - String - - - None - - - 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. - - FontFlags - - FontFlags - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MailFormat - - MailFormat - - - None - - - 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. - - EmailComposeMode - - EmailComposeMode - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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) - - MailReadingPanePosition - - MailReadingPanePosition - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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 - - Boolean - - Boolean - - - None - - - 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 - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - NavigationPaneView - - NavigationPaneView - - - None - - - 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. - - NewItemNotification - - NewItemNotification - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PreviewMarkAsReadBehavior - - PreviewMarkAsReadBehavior - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - ReadReceiptResponse - - ReadReceiptResponse - - - None - - - 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 <MailboxIdentity>`. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - AfterMoveOrDeleteBehavior - - AfterMoveOrDeleteBehavior - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - ConversationSortOrder - - ConversationSortOrder - - - None - - - 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. - - String - - String - - - None - - - 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. - - FontFlags - - FontFlags - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MailFormat - - MailFormat - - - None - - - 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. - - EmailComposeMode - - EmailComposeMode - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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) - - MailReadingPanePosition - - MailReadingPanePosition - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - Boolean - - Boolean - - - None - - - 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 - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - NavigationPaneView - - NavigationPaneView - - - None - - - 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. - - NewItemNotification - - NewItemNotification - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PreviewMarkAsReadBehavior - - PreviewMarkAsReadBehavior - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - ReadReceiptResponse - - ReadReceiptResponse - - - None - - - 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 <MailboxIdentity>`. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxmessageconfiguration - - - - - - Set-MailboxRegionalConfiguration - Set - MailboxRegionalConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - As shown in Example 5, you might need to set the DateFormat and TimeFormat parameter values to $null when you change the Language parameter value and you receive an error about invalid DateFormat values. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxRegionalConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). - - String - - String - - - None - - - Language - - The Language parameter specifies the language for the mailbox. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - - SwitchParameter - - - 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://docs.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). - - String - - String - - - None - - - 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. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). - - String - - String - - - None - - - Language - - The Language parameter specifies the language for the mailbox. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). - - String - - String - - - None - - - 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. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 4 -------------------------- - 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 forder names in Spanish. - - - - -------------------------- Example 5 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration - - - - - - Set-MailboxSpellingConfiguration - Set - MailboxSpellingConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailboxSpellingConfiguration - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - SpellCheckerSupportedLanguage - - SpellCheckerSupportedLanguage - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 - - SpellCheckerSupportedLanguage - - SpellCheckerSupportedLanguage - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Set-MailboxSpellingConfiguration -IgnoreMixedDigits $true -Identity kai - - This example sets the spelling checker to ignore words containing numbers for messages sent from Kai's mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailboxspellingconfiguration - - - - - - Set-MailContact - Set - MailContact - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailContact - - 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 - - MailContactIdParameter - - MailContactIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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. - - - SwitchParameter - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MacAttachmentFormat - - MacAttachmentFormat - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MessageBodyFormat - - MessageBodyFormat - - - None - - - 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. - - MessageFormat - - MessageFormat - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address that's used by the Unified Messaging (UM)-enabled mail contact. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - UseMapiRichTextFormat - - UseMapiRichTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - 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 - - MailContactIdParameter - - MailContactIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MacAttachmentFormat - - MacAttachmentFormat - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MessageBodyFormat - - MessageBodyFormat - - - None - - - 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. - - MessageFormat - - MessageFormat - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address that's used by the Unified Messaging (UM)-enabled mail contact. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - UseMapiRichTextFormat - - UseMapiRichTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-MailContact -Identity "John Rodman" -ExternalEmailAddress "john@contoso.com" - - This example sets John Rodman's external email address to john@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailcontact - - - - - - Set-MailUser - Set - MailUser - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailUser - - 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 - - MailUserIdParameter - - MailUserIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - ExchangeGuid - - This parameter is reserved for internal Microsoft use. - - Guid - - Guid - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MacAttachmentFormat - - MacAttachmentFormat - - - None - - - MailboxRegion - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MessageBodyFormat - - MessageBodyFormat - - - None - - - 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. - - MessageFormat - - MessageFormat - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$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 Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). - - SecureString - - SecureString - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveMailboxProvisioningConstraint - - This parameter is available only in the cloud-based service. - The RemoveMailboxProvisioningConstraint switch removes the mailbox provisioning constraint from the user. You don't need to specify a value with this switch. - You should use this switch when the provisioning constraint is no longer needed, or if it's preventing the mailbox from being moved. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). - - Boolean - - Boolean - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (UM)-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - UseMapiRichTextFormat - - UseMapiRichTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - UserCertificate - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - 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 - - MailUserIdParameter - - MailUserIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - ExchangeGuid - - This parameter is reserved for internal Microsoft use. - - Guid - - Guid - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ProxyAddress - - ProxyAddress - - - None - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - JournalArchiveAddress - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MacAttachmentFormat - - MacAttachmentFormat - - - None - - - MailboxRegion - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MessageBodyFormat - - MessageBodyFormat - - - None - - - 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. - - MessageFormat - - MessageFormat - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$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 Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). - - SecureString - - SecureString - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveMailboxProvisioningConstraint - - This parameter is available only in the cloud-based service. - The RemoveMailboxProvisioningConstraint switch removes the mailbox provisioning constraint from the user. You don't need to specify a value with this switch. - You should use this switch when the provisioning constraint is no longer needed, or if it's preventing the mailbox from being moved. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 Azure AD PowerShell. For connection instructions, see Connect to Office 365 PowerShell (https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). - - Boolean - - Boolean - - - None - - - SecondaryAddress - - The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (UM)-enabled user. - - String - - String - - - None - - - SecondaryDialPlan - - The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. - - UMDialPlanIdParameter - - UMDialPlanIdParameter - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - UseMapiRichTextFormat - - UseMapiRichTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - UserCertificate - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserSMimeCertificate - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailuser - - - - - - Set-ManagementRoleAssignment - Set - ManagementRoleAssignment - - This cmdlet is available in 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-ManagementRoleAssignment cmdlet to modify existing management role assignments. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When you modify a role assignment, you can specify a new predefined or custom management scope or provide an organizational unit (OU) to scope the existing role assignment. - You can create custom management scopes using the New-ManagementScope cmdlet and can view a list of existing scopes using the Get-ManagementScope cmdlet. If you choose not to specify an OU, predefined scope, or custom scope, the implicit write scope of the role applies to the role assignment. - For more information about management role assignments, see Understanding management role assignments (https://docs.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ManagementRoleAssignment - - Identity - - The Identity parameter specifies the name of the management role assignment to modify. If the name of the management role contains spaces, enclose it in quotation marks ("). - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 it in quotation marks ("). - If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope, RecipientRelativeWriteScope, or ExclusiveRecipientWriteScope parameters, and any configured OU or predefined scope on the role assignment is overwritten. - To remove a scope, specify a value of $null. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Enabled - - The Enabled parameter specifies whether the management role assignment is enabled or disabled. The valid values are $true and $false. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-ManagementRoleAssignment - - Identity - - The Identity parameter specifies the name of the management role assignment to modify. If the name of the management role contains spaces, enclose it in quotation marks ("). - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the management role assignment is enabled or disabled. The valid values are $true and $false. - - Boolean - - Boolean - - - None - - - ExclusiveRecipientWriteScope - - The ExclusiveRecipientWriteScope parameter specifies the existing recipient-based exclusive management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). - If you use the ExclusiveRecipientWriteScope parameter, you can't use the CustomRecipientWriteScope, RecipientOrganizationalUnitScope, or RecipientRelativeWriteScope parameters and any configured OU or predefined scope on the role assignment is overwritten. - To remove a scope, specify a value of $null. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-ManagementRoleAssignment - - Identity - - The Identity parameter specifies the name of the management role assignment to modify. If the name of the management role contains spaces, enclose it in quotation marks ("). - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the management role assignment is enabled or disabled. The valid values are $true and $false. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - RecipientAdministrativeUnitScope - - This parameter is available or functional only in the cloud-based service. - The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the role assignment to. - Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. - You can't use this parameter with any of the other scope parameters. - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-ManagementRoleAssignment - - Identity - - The Identity parameter specifies the name of the management role assignment to modify. If the name of the management role contains spaces, enclose it in quotation marks ("). - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the management role assignment is enabled or disabled. The valid values are $true and $false. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - RecipientOrganizationalUnitScope - - The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). - If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope, ExclusiveRecipientWriteScope, or RecipientRelativeWriteScope parameters and any predefined scopes or custom scopes on the role assignment are overwritten. - To specify an OU, use the syntax: domain/ou. To remove an OU, specify a value of $null. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-ManagementRoleAssignment - - Identity - - The Identity parameter specifies the name of the management role assignment to modify. If the name of the management role contains spaces, enclose it in quotation marks ("). - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the management role assignment is enabled or disabled. The valid values are $true and $false. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - RecipientRelativeWriteScope - - The RecipientRelativeWriteScope parameter specifies the type of restriction to apply to a recipient scope. - If you use the RecipientRelativeWriteScope parameter, you can't use the CustomRecipientWriteScope, ExclusiveRecipientWriteScope, or RecipientOrganizationalUnitScope parameters. - The available types are: None, Organization, MyGAL, Self and MyDistributionGroups. If you specify a predefined scope, any custom scope or configured OU on the role assignment is overwritten. - 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. - - RecipientWriteScopeType - - RecipientWriteScopeType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the management role assignment to modify. If the name of the management role contains spaces, enclose it in quotation marks ("). - - RoleAssignmentIdParameter - - RoleAssignmentIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 it in quotation marks ("). - If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope, RecipientRelativeWriteScope, or ExclusiveRecipientWriteScope parameters, and any configured OU or predefined scope on the role assignment is overwritten. - To remove a scope, specify a value of $null. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Enabled - - The Enabled parameter specifies whether the management role assignment is enabled or disabled. The valid values are $true and $false. - - Boolean - - Boolean - - - None - - - ExclusiveRecipientWriteScope - - The ExclusiveRecipientWriteScope parameter specifies the existing recipient-based exclusive management scope to associate with this management role assignment. If the management scope name contains spaces, enclose it in quotation marks ("). - If you use the ExclusiveRecipientWriteScope parameter, you can't use the CustomRecipientWriteScope, RecipientOrganizationalUnitScope, or RecipientRelativeWriteScope parameters and any configured OU or predefined scope on the role assignment is overwritten. - To remove a scope, specify a value of $null. - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - RecipientAdministrativeUnitScope - - This parameter is available or functional only in the cloud-based service. - The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the role assignment to. - Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. - You can't use this parameter with any of the other scope parameters. - - AdministrativeUnitIdParameter - - AdministrativeUnitIdParameter - - - None - - - RecipientOrganizationalUnitScope - - The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). - If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope, ExclusiveRecipientWriteScope, or RecipientRelativeWriteScope parameters and any predefined scopes or custom scopes on the role assignment are overwritten. - To specify an OU, use the syntax: domain/ou. To remove an OU, specify a value of $null. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - RecipientRelativeWriteScope - - The RecipientRelativeWriteScope parameter specifies the type of restriction to apply to a recipient scope. - If you use the RecipientRelativeWriteScope parameter, you can't use the CustomRecipientWriteScope, ExclusiveRecipientWriteScope, or RecipientOrganizationalUnitScope parameters. - The available types are: None, Organization, MyGAL, Self and MyDistributionGroups. If you specify a predefined scope, any custom scope or configured OU on the role assignment is overwritten. - 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. - - RecipientWriteScopeType - - RecipientWriteScopeType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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 -------------------------- - Set-ManagementRoleAssignment "Distribution Groups_Cairns Admins" -CustomRecipientWriteScope "Cairns Recipients" - - This example restricts the Distribution Groups_Cairns Admins role assignment using the Cairns Recipients custom recipient management scope. Users that are members of the Cairns Admins role group assigned the role assignment can create, modify, and remove only the distribution group objects that match the Cairns Recipients custom recipient management scope. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-managementroleassignment - - - - - - Set-ManagementRoleEntry - Set - ManagementRoleEntry - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Set-ManagementRoleEntry cmdlet changes the available parameters on an existing role entry. If you want to add parameters to a role entry, the parameters must exist in the role entry in the parent management role. If you want to remove parameters from a role entry, there can be no role entries in child roles that inherit those parameters from the role entry you want to change. You can't change role entries associated with built-in roles. - For more information about management role entries, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ManagementRoleEntry - - Identity - - The Identity parameter specifies the role entry that you want to modify. This parameter uses the syntax: `<management role><role entry name>` (for example, `CustomRole\Set-Mailbox`). - For more information about how management role entries work, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - If the role entry name contains spaces, enclose it in quotation marks ("). - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - String[] - - String[] - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the role entry that you want to modify. This parameter uses the syntax: `<management role><role entry name>` (for example, `CustomRole\Set-Mailbox`). - For more information about how management role entries work, see Understanding management roles (https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). - If the role entry name contains spaces, enclose it in quotation marks ("). - - RoleEntryIdParameter - - RoleEntryIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String[] - - String[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-managementroleentry - - - - - - Set-ManagementScope - Set - ManagementScope - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If you change a scope that has been associated with management role assignments using the New-ManagementRoleAssignment cmdlet, the updated scope applies to all the associated role assignments. For more information about changing scopes, see Change a role scope (https://docs.microsoft.com/exchange/change-a-role-scope-exchange-2013-help). - For more information about regular and exclusive scopes, see Understanding management role scopes (https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ManagementScope - - Identity - - The Identity parameter specifies the name of the management scope to modify. If the name contains spaces, enclose it in quotation marks ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, ServerList, or ServerRestrictionFilter parameters. - - String - - String - - - None - - - RecipientRoot - - The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. Valid input for this parameter is an OU or domain that's visibor domain that's returned bylUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - - Name - - Canonical name - - Distinguished name (DN) - - GUID - - You can't use this parameter with the ServerRestrictionFilter or DatabaseRestrictionFilter parameters. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the management scope to modify. If the name contains spaces, enclose it in quotation marks ("). - - ManagementScopeIdParameter - - ManagementScopeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, ServerList, or ServerRestrictionFilter parameters. - - String - - String - - - None - - - RecipientRoot - - The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. Valid input for this parameter is an OU or domain that's visibor domain that's returned bylUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - - Name - - Canonical name - - Distinguished name (DN) - - GUID - - You can't use this parameter with the ServerRestrictionFilter or DatabaseRestrictionFilter parameters. - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-managementscope - - - - - - Set-OfflineAddressBook - Set - OfflineAddressBook - - This cmdlet is available in 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-OfflineAddressBook cmdlet to modify offline address book (OAB) settings. - In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group (https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-OfflineAddressBook - - Identity - - 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 - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - 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. - - AddressBookBaseIdParameter[] - - AddressBookBaseIdParameter[] - - - None - - - ApplyMandatoryProperties - - 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. - - - SwitchParameter - - - False - - - ConfiguredAttributes - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - FullOabDownloadPreventionThreshold - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - UpgradeFromE14 - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - 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. - - - SwitchParameter - - - False - - - Versions - - The Versions parameter specifies the OAB versions that are generated for client download. In Exchange 2013 or later, the default and only supported value is Version4 (Version3 and Version2 require public folder distribution). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - ZipOabFilesBeforeUploading - - 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. - - Boolean - - Boolean - - - None - - - - - - Identity - - 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 - - OfflineAddressBookIdParameter - - OfflineAddressBookIdParameter - - - None - - - 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. - - AddressBookBaseIdParameter[] - - AddressBookBaseIdParameter[] - - - None - - - ApplyMandatoryProperties - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ConfiguredAttributes - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - FullOabDownloadPreventionThreshold - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - UpgradeFromE14 - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Versions - - The Versions parameter specifies the OAB versions that are generated for client download. In Exchange 2013 or later, the default and only supported value is Version4 (Version3 and Version2 require public folder distribution). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - ZipOabFilesBeforeUploading - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Set-OfflineAddressBook -Identity "\Default Offline Address Book" -GeneratingMailbox OABGen2 - - This example changes the organization mailbox that's responsible for generating the OAB. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-offlineaddressbook - - - - - - Set-OnPremisesOrganization - Set - OnPremisesOrganization - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with a Microsoft 365 organization. Typically, this object is only modified and updated by the Hybrid Configuration wizard. Manual modification of this object may result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-OnPremisesOrganization - - Identity - - The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - - Canonical name - - GUID - - Name - - OnPremisesOrganizationIdParameter - - OnPremisesOrganizationIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - OrganizationName - - The OrganizationName parameter specifies the Active Directory object name of the on-premises Exchange organization. - - String - - String - - - None - - - 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. - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - 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. - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the identity of the on-premises organization object. You can use the following values: - - Canonical name - - GUID - - Name - - OnPremisesOrganizationIdParameter - - OnPremisesOrganizationIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - OrganizationName - - The OrganizationName parameter specifies the Active Directory object name of the on-premises Exchange organization. - - String - - String - - - None - - - 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. - - OrganizationRelationshipIdParameter - - OrganizationRelationshipIdParameter - - - None - - - 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. - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 Microsoft 365 organization, which already has the contoso.com and sales.contoso.com domains. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-onpremisesorganization - - - - - - Set-PartnerApplication - Set - PartnerApplication - - This cmdlet is available or functional only in on-premises Exchange. - Use the Set-PartnerApplication cmdlet to configure partner application configurations in on-premises Exchange organizations. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can configure partner applications such as SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see Plan Exchange 2016 integration with SharePoint and Skype for Business (https://docs.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-PartnerApplication - - Identity - - 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 - - PartnerApplicationIdParameter - - PartnerApplicationIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - SupportedAccountType - - SupportedAccountType - - - None - - - ActAsPermissions - - The ActAsPermissions parameter specifies the delegate permissions that are allowed for the partner application. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - ApplicationIdentifier - - The ApplicationIdentifier parameter specifies a unique application identifier for the partner application that uses an authorization server. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UserIdParameter - - UserIdParameter - - - None - - - Name - - The Name parameter specifies a new name for the partner application. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - PartnerApplicationIdParameter - - PartnerApplicationIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - SupportedAccountType - - SupportedAccountType - - - None - - - ActAsPermissions - - The ActAsPermissions parameter specifies the delegate permissions that are allowed for the partner application. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - ApplicationIdentifier - - The ApplicationIdentifier parameter specifies a unique application identifier for the partner application that uses an authorization server. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UserIdParameter - - UserIdParameter - - - None - - - Name - - The Name parameter specifies a new name for the partner application. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-PartnerApplication HRApp -RefreshAuthMetadata - - This example refreshes the auth metadata for the HRApp partner application. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-partnerapplication - - - - - - Set-RoleAssignmentPolicy - Set - RoleAssignmentPolicy - - This cmdlet is available in 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-RoleAssignmentPolicy cmdlet to modify existing management role assignment policies in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the Set-RoleAssignmentPolicy cmdlet to change the name of an assignment policy or to set the assignment policy as the default assignment policy. - For more information about assignment policies, see Understanding management role assignment policies (https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-RoleAssignmentPolicy - - Identity - - The Identity parameter specifies the name of the assignment policy to modify. If the name contains spaces, enclose the name in quotation marks ("). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - Name - - The Name parameter specifies the new name of the assignment policy. If the assignment policy name contains spaces, enclose the name in quotation marks ("). The maximum length of the name is 64 characters. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the assignment policy to modify. If the name contains spaces, enclose the name in quotation marks ("). - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Name - - The Name parameter specifies the new name of the assignment policy. If the assignment policy name contains spaces, enclose the name in quotation marks ("). The maximum length of the name is 64 characters. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-RoleAssignmentPolicy "End User Policy" -IsDefault - - This example changes the default assignment policy. New mailboxes or mailboxes moved from previous versions of Exchange are assigned the default assignment policy when an explicit assignment policy isn't provided. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-roleassignmentpolicy - - - - - - Set-RoleGroup - Set - RoleGroup - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-RoleGroup - - Identity - - The Identity parameter specifies the name of the role group to modify. If the name contains spaces, enclose the name in quotation marks ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - ManagedBy - - The ManagedBy parameter specifies the users or USG who can modify the configuration of a role group or add or remove members to or from a role group. The list you specify with this parameter overwrites the existing ManagedBy list. To add or remove individual role group managers, and for more information about modifying multivalued properties, see Modifying multivalued properties (https://docs.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - String - - String - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name of the role group to modify. If the name contains spaces, enclose the name in quotation marks ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ManagedBy - - The ManagedBy parameter specifies the users or USG who can modify the configuration of a role group or add or remove members to or from a role group. The list you specify with this parameter overwrites the existing ManagedBy list. To add or remove individual role group managers, and for more information about modifying multivalued properties, see Modifying multivalued properties (https://docs.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - String - - String - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-rolegroup - - - - - - Set-SiteMailbox - Set - SiteMailbox - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes (https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). - Use the Set-SiteMailbox cmdlet to change a site mailbox's settings, such as the Microsoft SharePoint URL. This cmdlet is primarily used by the SharePoint and Microsoft Exchange user interfaces, such as the SharePoint URL. This cmdlet should only be used for diagnostic and troubleshooting purposes. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-SiteMailbox - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the site mailbox. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SharePointUrl - - The SharePointUrl parameter specifies the URL of the SharePoint site, for example, "https://myserver/teams/edu". - - Uri - - Uri - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the display name of the site mailbox. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SharePointUrl - - The SharePointUrl parameter specifies the URL of the SharePoint site, for example, "https://myserver/teams/edu". - - Uri - - Uri - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-sitemailbox - - - - - - Set-TenantAnalyticsConfig - Set - TenantAnalyticsConfig - - This cmdlet is available only in the cloud-based service. - This cmdlet has been deprecated and no longer used. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet has been deprecated and no longer used. - - - - Set-TenantAnalyticsConfig - - MinRecipients - - This cmdlet has been deprecated and no longer used. - - Int32 - - Int32 - - - None - - - - Set-TenantAnalyticsConfig - - MinRecipients - - This cmdlet has been deprecated and no longer used. - - Int32 - - Int32 - - - None - - - MinTeamSize - - This cmdlet has been deprecated and no longer used. - - Int32 - - Int32 - - - None - - - TeamAnalyticsEnabled - - This cmdlet has been deprecated and no longer used. - - Boolean - - Boolean - - - None - - - - - - MinRecipients - - This cmdlet has been deprecated and no longer used. - - Int32 - - Int32 - - - None - - - MinTeamSize - - This cmdlet has been deprecated and no longer used. - - Int32 - - Int32 - - - None - - - TeamAnalyticsEnabled - - This cmdlet has been deprecated and no longer used. - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-TenantAnalyticsConfig - - This cmdlet has been deprecated and no longer used. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-tenantanalyticsconfig - - - - - - Set-UnifiedGroup - Set - UnifiedGroup - - 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 group. There must be at least one MOERA address attached to a group at any given point of time. To learn more about MOERA addresses, see How the proxyAddresses attribute is populated in Azure AD (https://support.microsoft.com/help/3190357). Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Microsoft 365 Groups are group objects that are available across Microsoft 365 services. - The HiddenGroupMembershipEnabled parameter is only available on the New-UnifiedGroup cmdlet. You can't change this setting on an existing Microsoft 365 Group group. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UnifiedGroup - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 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. - - ModernGroupTypeInfo - - ModernGroupTypeInfo - - - None - - - 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 value of Alias can contain letters, numbers and the following 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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - - SwitchParameter - - - 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 `. - - - SwitchParameter - - - False - - - Classification - - The Classification parameter specifies the classification for the Microsoft 365 Group. You need to configure the list of available classifications in Azure Active Directory before you can specify a value for this parameter. For more information, see Azure Active Directory cmdlets for configuring group settings (https://docs.microsoft.com/azure/active-directory/users-groups-roles/groups-settings-cmdlets). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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). - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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 group. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. This is the default value. - - Boolean - - Boolean - - - None - - - HiddenFromExchangeClientsEnabled - - The HiddenFromExchangeClientsEnabled switch specifies whether the Microsoft 365 Group is hidden from Outlook clients connected to Microsoft 365. - - To enable this setting, you don't need to specify a value with this switch. The Microsoft 365 Group is hidden from Outlook experiences. The group isn't visible in the Outlook left-hand navigation and isn't be visible in the global address list (GAL). The group name won't resolve during the creation a new message in Outlook. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users also can't find the group by using the Discover option in Outlook on the web. Additionally, the HiddenFromAddressListsEnabled property will also be set to true to prevent the group from showing in the GAL and in the Offline Address Book (OAB). - - To disable this setting, use this exact syntax: -HiddenFromExchangeClientsEnabled:$false. The Microsoft 365 Group is not hidden from Outlook experiences. The group will be visible in the GAL and other address lists. This is the default value. - - - SwitchParameter - - - False - - - Language - - The Language parameter specifies language preference for the Microsoft 365 Group. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - MailboxRegion - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Notes - - The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SubscriptionEnabled - - The SubscriptionEnabled switch specifies whether subscriptions to conversations and calendar events are enabled for the Microsoft 365 Group. - - To change the value to $true, use this switch without a value. - - To change the value to $false, use this exact syntax: -SubscriptionEnabled:$false. - - - SwitchParameter - - - 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 is enabled by default. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 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. - - ModernGroupTypeInfo - - ModernGroupTypeInfo - - - None - - - 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 value of Alias can contain letters, numbers and the following 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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 `. - - SwitchParameter - - SwitchParameter - - - False - - - Classification - - The Classification parameter specifies the classification for the Microsoft 365 Group. You need to configure the list of available classifications in Azure Active Directory before you can specify a value for this parameter. For more information, see Azure Active Directory cmdlets for configuring group settings (https://docs.microsoft.com/azure/active-directory/users-groups-roles/groups-settings-cmdlets). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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). - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 group. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. This is the default value. - - Boolean - - Boolean - - - None - - - HiddenFromExchangeClientsEnabled - - The HiddenFromExchangeClientsEnabled switch specifies whether the Microsoft 365 Group is hidden from Outlook clients connected to Microsoft 365. - - To enable this setting, you don't need to specify a value with this switch. The Microsoft 365 Group is hidden from Outlook experiences. The group isn't visible in the Outlook left-hand navigation and isn't be visible in the global address list (GAL). The group name won't resolve during the creation a new message in Outlook. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users also can't find the group by using the Discover option in Outlook on the web. Additionally, the HiddenFromAddressListsEnabled property will also be set to true to prevent the group from showing in the GAL and in the Offline Address Book (OAB). - - To disable this setting, use this exact syntax: -HiddenFromExchangeClientsEnabled:$false. The Microsoft 365 Group is not hidden from Outlook experiences. The group will be visible in the GAL and other address lists. This is the default value. - - SwitchParameter - - SwitchParameter - - - False - - - Language - - The Language parameter specifies language preference for the Microsoft 365 Group. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - MailboxRegion - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Notes - - The Notes parameter specifies the description of the Microsoft 365 Group. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SubscriptionEnabled - - The SubscriptionEnabled switch specifies whether subscriptions to conversations and calendar events are enabled for the Microsoft 365 Group. - - To change the value to $true, use this switch without a value. - - To change the value to $false, use this exact syntax: -SubscriptionEnabled:$false. - - SwitchParameter - - SwitchParameter - - - 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 is enabled by default. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-unifiedgroup - - - - - - Set-User - Set - User - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Set-User cmdlet contains no mail-related properties for mailboxes or mail users. To modify the mail-related properties for a user, you need to use the corresponding cmdlet based on the object type (for example, Set-Mailbox or Set-MailUser). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-User - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - UserPrincipalName - - UserIdParameter - - UserIdParameter - - - None - - - AllowUMCallsFromNonUsers - - The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user from directory searches. - - AllowUMCallsFromNonUsersFlags - - AllowUMCallsFromNonUsersFlags - - - None - - - AssistantName - - The AssistantName parameter specifies the name of the user's assistant. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - BlockCloudCache - - This parameter is available only in the cloud-based service. - {{ Fill BlockCloudCache Description }} - - Boolean - - Boolean - - - None - - - CanHaveCloudCache - - This parameter is available only in the cloud-based service. - {{ Fill CanHaveCloudCache Description }} - - Boolean - - Boolean - - - None - - - City - - The City parameter specifies the user's city. - - String - - String - - - None - - - Company - - The Company parameter specifies the user's company. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - CountryInfo - - CountryInfo - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Department - - The Department parameter specifies the user's department. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - Fax - - The Fax parameter specifies the user's fax number. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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" - - GeoCoordinates - - GeoCoordinates - - - None - - - HomePhone - - The HomePhone parameter specifies the user's home telephone number. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - Manager - - The Manager parameter specifies the user's manager. - - UserContactIdParameter - - UserContactIdParameter - - - None - - - MobilePhone - - The MobilePhone parameter specifies the user's primary mobile phone number. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - OtherFax - - The OtherFax parameter specifies the user's alternative fax number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OtherHomePhone - - The OtherHomePhone parameter specifies the user's alternative home telephone number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OtherTelephone - - The OtherTelephone parameter specifies the user's alternative telephone number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Pager - - The Pager parameter specifies the user's pager number. - - String - - String - - - None - - - 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 Microsoft 365. For more information, see Permanently Clear Previous Mailbox Info (https://techcommunity.microsoft.com/t5/exchange-team-blog/permanently-clear-previous-mailbox-info/ba-p/607619). Caution : This switch permanently deletes the existing cloud mailbox and its associated archive, prevents you from reconnecting to the mailbox, and prevents you from recovering content from the mailbox. - - - SwitchParameter - - - False - - - Phone - - The Phone parameter specifies the user's office telephone number. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - PostalCode - - The PostalCode parameter specifies the user's zip code or postal code. - - String - - String - - - None - - - PostOfficeBox - - The PostOfficeBox parameter specifies the user's post office box number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - RemoveMailboxProvisioningConstraint - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - StateOrProvince - - The StateOrProvince parameter specifies the user's state or province. - - String - - String - - - None - - - StreetAddress - - The StreetAddress parameter specifies the user's physical address. - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - Title - - The Title parameter specifies the user's title. - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/admin/setup/priority-accounts). - - Boolean - - Boolean - - - None - - - WebPage - - The WebPage parameter specifies the user's Web page. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - 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 - - Distinguished name (DN) - - Canonical DN - - GUID - - UserPrincipalName - - UserIdParameter - - UserIdParameter - - - None - - - AllowUMCallsFromNonUsers - - The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user from directory searches. - - AllowUMCallsFromNonUsersFlags - - AllowUMCallsFromNonUsersFlags - - - None - - - AssistantName - - The AssistantName parameter specifies the name of the user's assistant. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - BlockCloudCache - - This parameter is available only in the cloud-based service. - {{ Fill BlockCloudCache Description }} - - Boolean - - Boolean - - - None - - - CanHaveCloudCache - - This parameter is available only in the cloud-based service. - {{ Fill CanHaveCloudCache Description }} - - Boolean - - Boolean - - - None - - - City - - The City parameter specifies the user's city. - - String - - String - - - None - - - Company - - The Company parameter specifies the user's company. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - CountryInfo - - CountryInfo - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Department - - The Department parameter specifies the user's department. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - Fax - - The Fax parameter specifies the user's fax number. - - String - - String - - - None - - - FirstName - - The FirstName parameter specifies the user's first name. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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" - - GeoCoordinates - - GeoCoordinates - - - None - - - HomePhone - - The HomePhone parameter specifies the user's home telephone number. - - String - - String - - - None - - - Initials - - The Initials parameter specifies the user's middle initials. - - String - - String - - - None - - - LastName - - The LastName parameter specifies the user's last name. - - String - - String - - - None - - - Manager - - The Manager parameter specifies the user's manager. - - UserContactIdParameter - - UserContactIdParameter - - - None - - - MobilePhone - - The MobilePhone parameter specifies the user's primary mobile phone number. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Office - - The Office parameter specifies the user's physical office name or number. - - String - - String - - - None - - - OtherFax - - The OtherFax parameter specifies the user's alternative fax number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OtherHomePhone - - The OtherHomePhone parameter specifies the user's alternative home telephone number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - OtherTelephone - - The OtherTelephone parameter specifies the user's alternative telephone number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Pager - - The Pager parameter specifies the user's pager number. - - String - - String - - - None - - - 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 Microsoft 365. For more information, see Permanently Clear Previous Mailbox Info (https://techcommunity.microsoft.com/t5/exchange-team-blog/permanently-clear-previous-mailbox-info/ba-p/607619). Caution : This switch permanently deletes the existing cloud mailbox and its associated archive, prevents you from reconnecting to the mailbox, and prevents you from recovering content from the mailbox. - - SwitchParameter - - SwitchParameter - - - False - - - Phone - - The Phone parameter specifies the user's office telephone number. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - PostalCode - - The PostalCode parameter specifies the user's zip code or postal code. - - String - - String - - - None - - - PostOfficeBox - - The PostOfficeBox parameter specifies the user's post office box number. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - RemoveMailboxProvisioningConstraint - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - StateOrProvince - - The StateOrProvince parameter specifies the user's state or province. - - String - - String - - - None - - - StreetAddress - - The StreetAddress parameter specifies the user's physical address. - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - Title - - The Title parameter specifies the user's title. - - String - - String - - - None - - - 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:<integers2>}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/microsoft-365/admin/setup/priority-accounts). - - Boolean - - Boolean - - - None - - - WebPage - - The WebPage parameter specifies the user's Web page. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-user - - - - - - Set-UserAnalyticsConfig - Set - UserAnalyticsConfig - - This cmdlet is available only in the cloud-based service. Note : This cmdlet has been replaced by the Set-MyAnalyticsFeatureConfig cmdlet in the Exchange Online PowerShell V2 module version 2.0.4 or later. For connection instructions using the module, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UserAnalyticsConfig - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - RecipientIdParameter - - RecipientIdParameter - - - None - - - PrivacyMode - - The PrivacyMode parameter specifies the MyAnalytics privacy setting for the user. Valid values are: - - Excluded - - Opt-In - - Opt-Out - - String - - String - - - None - - - - Set-UserAnalyticsConfig - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - RecipientIdParameter - - RecipientIdParameter - - - None - - - PrivacyMode - - The PrivacyMode parameter specifies the MyAnalytics privacy setting for the user. Valid values are: - - Excluded - - Opt-In - - Opt-Out - - String - - String - - - None - - - TeamAnalyticsEnabled - - PARAMVALUE: Boolean - - Boolean - - Boolean - - - None - - - TeamAnalyticsManagerViewEnabled - - PARAMVALUE: Boolean - - Boolean - - Boolean - - - None - - - - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - RecipientIdParameter - - RecipientIdParameter - - - None - - - PrivacyMode - - The PrivacyMode parameter specifies the MyAnalytics privacy setting for the user. Valid values are: - - Excluded - - Opt-In - - Opt-Out - - String - - String - - - None - - - TeamAnalyticsEnabled - - PARAMVALUE: Boolean - - Boolean - - Boolean - - - None - - - TeamAnalyticsManagerViewEnabled - - PARAMVALUE: Boolean - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-UserAnalyticsConfig -Identity "Kathleen Reiter" -PrivacyMode Opt-In - - This example sets the MyAnalytics privacy setting to Opt-In for the user named Kathleen Reiter. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-useranalyticsconfig - - - - - - Set-UserPhoto - Set - UserPhoto - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-UserPhoto - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Cancel - - The Cancel switch parameter deletes the photo that's currently uploaded as the preview photo. You don't need to specify a value with this switch. - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-UserPhoto - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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>"))`. For example `([System.IO.File]::ReadAllBytes("C:\Documents\Pictures\MyPhoto.jpg"))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-UserPhoto - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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>"))`. For example `([System.IO.File]::ReadAllBytes("C:\Documents\Pictures\MyPhoto.jpg"))`. - - Byte[] - - Byte[] - - - None - - - 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. - - Stream - - Stream - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-UserPhoto - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Stream - - Stream - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-UserPhoto - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Cancel - - The Cancel switch parameter deletes the photo that's currently uploaded as the preview photo. You don't need to specify a value with this switch. - 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. - - SwitchParameter - - SwitchParameter - - - 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>"))`. For example `([System.IO.File]::ReadAllBytes("C:\Documents\Pictures\MyPhoto.jpg"))`. - - Byte[] - - Byte[] - - - None - - - 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. - - Stream - - Stream - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - GroupMailbox - - The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - PhotoType - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-userphoto - - - - - - Test-ApplicationAccessPolicy - Test - ApplicationAccessPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This feature applies only to apps connecting to the Microsoft Graph API for Outlook resources. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-ApplicationAccessPolicy - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - String - - String - - - None - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-applicationaccesspolicy - - - - - - Test-SiteMailbox - Test - SiteMailbox - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes (https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). - Use the Test-SiteMailbox cmdlet to test the site mailbox to Microsoft SharePoint connectivity and to test whether users have the correct permissions to use a site mailbox. This cmdlet should be used for troubleshooting and diagnostic purposes. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If you don't specify the RequestorIdentity parameter, the command uses the identification of the user running this command. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-SiteMailbox - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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 parameter with the RequestorIdentity parameter. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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 parameter with the RequestorIdentity parameter. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-sitemailbox - - - - - - Undo-SoftDeletedMailbox - Undo - SoftDeletedMailbox - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Undo-SoftDeletedMailbox - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the new display name for the recovered mailbox. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Undo-SoftDeletedMailbox - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the new display name for the recovered mailbox. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Password - - The Password parameter specifies a new password for the mailbox. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$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. - - SecureString - - SecureString - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - SoftDeletedObject - - The SoftDeletedObject parameter specifies the deleted mailbox to recover. You can use the alias or the email address of the deleted mailbox for the value of this parameter. Use the Get-Mailbox -SoftDeletedMailbox command to get information for deleted mailboxes. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DisplayName - - The DisplayName parameter specifies the new display name for the recovered mailbox. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Password - - The Password parameter specifies a new password for the mailbox. - This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$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. - - SecureString - - SecureString - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - WindowsLiveId - - WindowsLiveId - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/undo-softdeletedmailbox - - - - - - Undo-SoftDeletedUnifiedGroup - Undo - SoftDeletedUnifiedGroup - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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-AzureADMSDeletedGroup cmdlet in Azure Active Directory PowerShell. To permanently remove (purge) a soft-deleted Microsoft 365 Group, use the Remove-AzureADMSDeletedDirectoryObject cmdlet in Azure Active Directory PowerShell. For more information, see Permanently delete a Microsoft 365 Group (https://docs.microsoft.com/microsoft-365/admin/create-groups/restore-deleted-group#permanently-delete-a-microsoft-365-group). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Undo-SoftDeletedUnifiedGroup - - 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. - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - UnifiedGroupIdParameter - - UnifiedGroupIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Undo-SoftDeletedUnifiedGroup -SoftDeletedObject "Marketing Department" - - This example restores the soft-deleted Microsoft 365 Group named Marketing Department. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/undo-softdeletedunifiedgroup - - - - - - Update-EOPDistributionGroupMember - Update - EOPDistributionGroupMember - - This cmdlet is available only in Exchange Online Protection. - Use the Update-EOPDistributionGroupMember cmdlet to add or remove members from distribution groups and mail-enabled security groups in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Update-DistributionGroupMember cmdlet instead. - Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Update-EOPDistributionGroupMember - - Identity - - The Identity parameter specifies the distribution group or mail-enabled security group that you want to update. You can use any value that uniquely identifies the group. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Members - - The Members parameter specifies the list of recipients (mail-enabled objects) in the distribution group or mail-enabled security group. In Exchange Online Protection, the valid recipient types are: - - Mail users - - Distribution groups - - Mail-enabled security groups - - You can use any value that uniquely identifies the recipient. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - To replace the current members of the group with the recipients that you specify, use the syntax `@("Recipient1","Recipient2",..."RecipientN")`. To add new group members without affecting the existing members, see Example 2 in the Examples section. - - String[] - - String[] - - - None - - - - - - Identity - - The Identity parameter specifies the distribution group or mail-enabled security group that you want to update. You can use any value that uniquely identifies the group. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - DistributionGroupIdParameter - - DistributionGroupIdParameter - - - None - - - ExternalDirectoryObjectId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Members - - The Members parameter specifies the list of recipients (mail-enabled objects) in the distribution group or mail-enabled security group. In Exchange Online Protection, the valid recipient types are: - - Mail users - - Distribution groups - - Mail-enabled security groups - - You can use any value that uniquely identifies the recipient. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - To replace the current members of the group with the recipients that you specify, use the syntax `@("Recipient1","Recipient2",..."RecipientN")`. To add new group members without affecting the existing members, see Example 2 in the Examples section. - - String[] - - String[] - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/update-eopdistributiongroupmember - - - - - - Update-HybridConfiguration - Update - HybridConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Update-HybridConfiguration - - OnPremisesCredentials - - The OnPremisesCredentials parameter specifies the on-premises Active Directory account and password that's used to configure the hybrid configuration object. This account must be a member of the Organization Management role group. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - TenantCredentials - - The TenantCredentials parameter specifies the Microsoft 365 organization account and password that's used to configure the hybrid configuration object. This is often the administrator account that's assigned when the Microsoft 365 organization was created. This account must be a member of the Global admin role. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - SuppressOAuthWarning - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - OnPremisesCredentials - - The OnPremisesCredentials parameter specifies the on-premises Active Directory account and password that's used to configure the hybrid configuration object. This account must be a member of the Organization Management role group. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - TenantCredentials - - The TenantCredentials parameter specifies the Microsoft 365 organization account and password that's used to configure the hybrid configuration object. This is often the administrator account that's assigned when the Microsoft 365 organization was created. This account must be a member of the Global admin role. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - SuppressOAuthWarning - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/update-hybridconfiguration - - - - - - Update-Recipient - Update - Recipient - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Update-Recipient - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/update-recipient - - - - - - Update-RoleGroupMember - Update - RoleGroupMember - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Update-RoleGroupMember - - 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 ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - - SwitchParameter - - - False - - - - - - 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 ("). - - RoleGroupIdParameter - - RoleGroupIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - This parameter doesn't work in the 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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://docs.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`. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/update-rolegroupmember - - - - - - Update-SiteMailbox - Update - SiteMailbox - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes (https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). - Use the Update-SiteMailbox cmdlet to trigger a Microsoft SharePoint synchronization. This command synchronizes document content membership and permissions into Microsoft Exchange. You may need to perform this action when troubleshooting document or membership synchronization issues. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If you are running this command against a site mailbox in which you aren't the owner, you need to use the BypassOwnerCheck parameter to run this cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Update-SiteMailbox - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - FullSync - - The FullSync parameter specifies full sync is expensive and will have a performance impact on the Exchange system. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - TargetType - - TargetType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - FullSync - - The FullSync parameter specifies full sync is expensive and will have a performance impact on the Exchange system. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - TargetType - - TargetType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/update-sitemailbox - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.ServerStatus-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.ServerStatus-Help.xml deleted file mode 100644 index 4db108d6efdb..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.ServerStatus-Help.xml +++ /dev/null @@ -1,21257 +0,0 @@ - - - - - Delete-QuarantineMessage - Delete - QuarantineMessage - - This cmdlet is available only in the cloud-based service. - Use the Delete-QuarantineMessage cmdlet to delete quarantine messages from your cloud-based organization Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Delete-QuarantineMessage - - 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. - - QuarantineMessageIdentity[] - - QuarantineMessageIdentity[] - - - None - - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Delete-QuarantineMessage - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - QuarantineMessageIdentity[] - - QuarantineMessageIdentity[] - - - None - - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/delete-quarantinemessage - - - - - - Enable-OrganizationCustomization - Enable - OrganizationCustomization - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - Whether or not this command has been previously run in an organization is available in the IsDehydrated property of the Get-OrganizationConfig cmdlet: False ($false) = the command has already been run; True ($true) = the command has never been run. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-OrganizationCustomization - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-OrganizationCustomization - - This example runs the command as required. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-organizationcustomization - - - - - - Export-QuarantineMessage - Export - QuarantineMessage - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Export-QuarantineMessage - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - - - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/export-quarantinemessage - - - - - - Get-AdvancedThreatProtectionDocumentDetail - Get - AdvancedThreatProtectionDocumentDetail - - This cmdlet is available only in the cloud-based service. - Use the Get-AdvancedThreatProtectionDocumentDetailReport cmdlet to view the detailed results of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in your Microsoft Defender for Office 365 organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For the reporting period and organization you specify, the cmdlet returns the following information: - - Action - - Document Id - - Domain - - Event Type - - File Hash - - File Name - - File Path - - Size - - Timestamp - - Workload - - For more information about this feature, see Safe Attachments for SharePoint, OneDrive, and Microsoft Teams (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AdvancedThreatProtectionDocumentDetail - - Action - - The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - - Allow - - BlockAccess - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Organization - - The Organization parameter specifies the organization for which the report is being presented. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - Action - - The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - - Allow - - BlockAccess - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Organization - - The Organization parameter specifies the organization for which the report is being presented. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AdvancedThreatProtectionDocumentDetail -Organization contoso.com -StartDate "4/26/2016" -EndDate "4/28/2016" | Format-Table - - This example returns the detailed report of detections during the specified date range. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-advancedthreatprotectiondocumentdetail - - - - - - Get-AdvancedThreatProtectionDocumentReport - Get - AdvancedThreatProtectionDocumentReport - - This cmdlet is available only in the cloud-based service. - Use the Get-AdvancedThreatProtectionDocumentReport cmdlet to view the results of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in your Microsoft Defender for Office 365 organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For more information about this feature, see Safe Attachments for SharePoint, OneDrive, and Microsoft Teams (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). - For the reporting period and organization you specify, the cmdlet returns the following information: - - Action - - Count - - Date - - Domain - - Event Type - - Workload - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AdvancedThreatProtectionDocumentReport - - Action - - The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - - Allow - - BlockAccess - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Organization - - The Organization parameter specifies the organization for which the report is being presented. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - - - - Action - - The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - - Allow - - BlockAccess - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Organization - - The Organization parameter specifies the organization for which the report is being presented. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AdvancedThreatProtectionTrafficReport -Organization contoso.com -StartDate "4/26/2018" -EndDate "4/28/2018" | Format-Table - - This example returns the aggregated report of detections for the specified organization during the specified date range. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-advancedthreatprotectiondocumentreport - - - - - - Get-AdvancedThreatProtectionTrafficReport - Get - AdvancedThreatProtectionTrafficReport - - 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 the last 90 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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: - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AdvancedThreatProtectionTrafficReport - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DisplayBy - - The DisplayBy parameter specifies how the information in the report is organized. Valid values are: - - Action (This is the default value) - - MalwareName - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DisplayBy - - The DisplayBy parameter specifies how the information in the report is organized. Valid values are: - - Action (This is the default value) - - MalwareName - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-advancedthreatprotectiontrafficreport - - - - - - Get-ApplicationAccessPolicy - Get - ApplicationAccessPolicy - - This cmdlet is available only in the cloud-based service. - Use the Get-ApplicationAccessPolicy cmdlet to view the list of application access policies. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This feature applies only to apps connecting to the Microsoft Graph API for Outlook resources. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ApplicationAccessPolicy - - 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. - - ApplicationAccessPolicyIdParameter - - ApplicationAccessPolicyIdParameter - - - None - - - - - - 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. - - ApplicationAccessPolicyIdParameter - - ApplicationAccessPolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ApplicationAccessPolicy | Format-Table -Auto Description,ScopeName,AccessRight - - This example returns a summary list of all application access policies in the organization. - - - - -------------------------- Example 2 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-applicationaccesspolicy - - - - - - Get-ATPTotalTrafficReport - Get - ATPTotalTrafficReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For the reporting period and organization you specify, the cmdlet returns the following information: - - EventType - - Organization - - Date - - MessageCount - - StartDate - - EndDate - - AggregateBy - - Index - - By default, the command returns data for the last 14 days. Data for the last 90 days is available. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ATPTotalTrafficReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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, the SummarizedBy parameter accepts the value EventType. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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, the SummarizedBy parameter accepts the value EventType. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ATPTotalTrafficReport -StartDate (get-date).AddDays(-5) -EndDate (get-date).AddDays(-1) - - This example returns data for the last 5 days. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-atptotaltrafficreport - - - - - - Get-CompromisedUserAggregateReport - Get - CompromisedUserAggregateReport - - This cmdlet is available only in the cloud-based service. - Use the Get-CompromisedUserAggregateReport cmdlet to return general data about compromised users for the last 90 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CompromisedUserAggregateReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. - - System.DateTime - - System.DateTime - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. - - System.DateTime - - System.DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-CompromisedUserAggregateReport -StartDate 06-01-2020 -EndDate 06-10-2020 -Action Restricted - - This example returns all restricted user accounts for the specified date range. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-compromiseduseraggregatereport - - - - - - Get-CompromisedUserDetailReport - Get - CompromisedUserDetailReport - - This cmdlet is available only in the cloud-based service. - Use the Get-CompromisedUserDetailReport cmdlet to return detailed information about compromised users for the last 30 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CompromisedUserDetailReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. - - System.DateTime - - System.DateTime - - - None - - - Page - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. - - System.DateTime - - System.DateTime - - - None - - - Page - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MailFlowStatusReport -StartDate 06-01-2020 -EndDate 06-10-2020 -Action Suspicious - - This example returns all suspicious user accounts for the specified date range. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-compromiseduserdetailreport - - - - - - Get-ConnectionByClientTypeDetailReport - Get - ConnectionByClientTypeDetailReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ConnectionByClientTypeDetailReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-connectionbyclienttypedetailreport - - - - - - Get-ConnectionByClientTypeReport - Get - ConnectionByClientTypeReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-ConnectionByClientTypeReport cmdlet to view a summary of the different types of clients that connected to all mailboxes in your organization. The client types indicate different protocols, for example, Outlook on the web, MAPI, POP3, IMAP4, Exchange ActiveSync, and Exchange Web Services. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Note : There's a 7-day lag in the client connection information that's returned by this cmdlet. For example, if you run the cmdlet on June 18, 2018, you can't retrieve information about connections made to mailboxes between June 13, 2018 and June 15, 2018. To get connection information for that date range, you need to run the cmdlet on June 22, 2018 or later. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ConnectionByClientTypeReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-connectionbyclienttypereport - - - - - - Get-CsActiveUserReport - Get - CsActiveUserReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsActiveUserReport cmdlet to view statistics about Skype for Business Online users in your cloud-based organization. The cmdlet shows the total number of unique users that signed in and took part in at least one peer-to-peer session or conference during the specified time period. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the Get-CsActiveUserReport to query information about the activities of Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - - ActiveUsers - - ActiveIMUsers - - ActiveAudioUsers - - ActiveVideoUsers - - ActiveApplicationSharingUsers - - ActiveFileTransferUsers - - ActivePSTNConferencingUsers - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsActiveUserReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-csactiveuserreport - - - - - - Get-CsAVConferenceTimeReport - Get - CsAVConferenceTimeReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsAVConferenceTimeReport cmdlet to view statistics about the time in minutes that was used during audio and video conferences that were held by Skype for Business Online users in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the Get-CsAVConferenceTimeReport to query information about the length of audio and video conferences held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - - AVConferenceMinutes - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsAVConferenceTimeReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-csavconferencetimereport - - - - - - Get-CsClientDeviceDetailReport - Get - CsClientDeviceDetailReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsClientDeviceDetailReport cmdlet to view statistics about the number of peer-to-peer sessions and conferences by users and devices that connected to Skype for Business Online in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-CsClientDeviceDetailReport cmdlet returns the number of peer-to-peer sessions and conferences that a user participated in, and a count of what type of device they used. You can query this information for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - - UserName - - WindowsActivities: Note that this includes activity using both Skype for Business and Skype for Business Web App clients. - - WindowsPhoneActivities - - AndroidActivities - - iPhoneActivities - - iPadActivities - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsClientDeviceDetailReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - UserName - - The UserName parameter filters the results by user. You identify the user by their account (for example, laura@contoso.com). - - String - - String - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - UserName - - The UserName parameter filters the results by user. You identify the user by their account (for example, laura@contoso.com). - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-csclientdevicedetailreport - - - - - - Get-CsClientDeviceReport - Get - CsClientDeviceReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsClientDeviceReport cmdlet to view statistics about the client devices that connected to Skype for Business Online in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-CsClientDeviceReport cmdlet returns the monthly total of unique users that connected to the Skype for Business Online service using different types of client devices. For the reporting period you specify, the cmdlet returns the following information: - - WindowsUsers - - WindowsPhoneUsers - - AndroidUsers - - iPhoneUsers - - iPadUsers - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsClientDeviceReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-csclientdevicereport - - - - - - Get-CsConferenceReport - Get - CsConferenceReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsConferenceReport cmdlet to view statistics about the conferences that were held by Skype for Business Online users in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the Get-CsConferenceReport to query information about the type and number of conferences held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - - TotalConferences - - AVConferences - - IMConferences - - ApplicationSharingConferences - - WebConferences - - TelephonyConferences - - PSTNConferences - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsConferenceReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-csconferencereport - - - - - - Get-CsP2PAVTimeReport - Get - CsP2PAVTimeReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsP2PAVTimeReport cmdlet to view statistics about the audio and video time in minutes that was used during peer-to-peer (P2P) sessions that were held by Skype for Business Online users in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the Get-CsP2PAVTimeReport to query information about the length of audio and video conferences held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - - TotalAudioMinutes - - TotalVideoMinutes - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsP2PAVTimeReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-csp2pavtimereport - - - - - - Get-CsP2PSessionReport - Get - CsP2PSessionReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsP2PSessionReport cmdlet to view statistics about the peer-to-peer (P2P) sessions held by Skype for Business Online users in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the Get-CsP2PSessionReport to query information about the number and type of P2P sessions held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - - TotalP2PSessions - - P2PIMSessions - - P2PAudioSessions - - P2PVideoSessions - - P2PApplicationSharingSessions - - P2PFileTransferSessions - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsP2PSessionReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-csp2psessionreport - - - - - - Get-CsPSTNConferenceTimeReport - Get - CsPSTNConferenceTimeReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsPSTNConferenceTimeReport cmdlet to show the number of minutes that Skype for Business Online users spent in dial-in or dial-out conferences. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the Get-CsPSTNUsageDetailReport to query information about length of time spent in dial-in and dial-out conferences by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - - PSTNConferenceDialInMinutes - - PSTNConferenceDialOutMinutes - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsPSTNConferenceTimeReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-cspstnconferencetimereport - - - - - - Get-CsPSTNUsageDetailReport - Get - CsPSTNUsageDetailReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsPSTNUsageDetailReport cmdlet to view public switched telephone network (PSTN) usage details for Skype for Business Online users. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsPSTNUsageDetailReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-cspstnusagedetailreport - - - - - - Get-CsUserActivitiesReport - Get - CsUserActivitiesReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsUserActivitiesReport cmdlet to view number and type of activities that a use participated in while connected to Skype for Business Online in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the Get-CsUserActivitiesReport to query information about activities in Skype for Business Online by all users or a specified user for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - - UserName - - LastLogonTime - - LastActivityTime - - TotalP2PSessions - - TotalP2PIMSessions - - TotalP2PAudioSessions - - TotalP2PVideoSessions - - TotalP2PApplicationSharingSessions - - TotalP2PAudioSessionMinutes - - TotalP2PVideoSessionMinutes - - TotalOrganizedConferences - - TotalOrganizedIMConferences - - TotalOrganizedAVConferences - - TotalOrganizedApplicationSharingConferences - - TotalOrganizedWebConferences - - TotalOrganizedDialInConferences - - TotalOrganizedAVConferenceMinutes - - TotalParticipatedConferences - - TotalParticipatedIMConferences - - TotalParticipatedAVConferences - - TotalParticipatedApplicationSharingConferences - - TotalParticipatedWebConferences - - TotalParticipatedDialInConferences - - TotalParticipatedAVConferenceMinutes - - TotalPlacedPSTNCalls - - TotalReceivedPSTNCalls - - TotalPlacedPSTNCallMinutes - - TotalReceivedPSTNCallMinutes - - TotalMessages - - TotalTransferredFiles - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsUserActivitiesReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - - DateTime - - DateTime - - - None - - - UserName - - The UserName parameter filters the results by user. You identify the user by their account (for example, laura@contoso.com). - - String - - String - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - - DateTime - - DateTime - - - None - - - UserName - - The UserName parameter filters the results by user. You identify the user by their account (for example, laura@contoso.com). - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-csuseractivitiesreport - - - - - - Get-CsUsersBlockedReport - Get - CsUsersBlockedReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-CsUsersBlockedReport cmdlet to view Skype for Business Online users who have been blocked due to fraudulent call activities. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can use the Get-CsUsersBlockedReport to query information about blocked users in Skype for Business Online for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - - ActionDate - - SIPURI - - ActionType - - TelephoneNumber - - Reason - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CsUsersBlockedReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-CsUsersBlockedReport -StartDate 11/01/2015 -EndDate 12/30/2015 - - This example shows the list of blocked users for November and December. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-csusersblockedreport - - - - - - Get-DataClassificationConfig - Get - DataClassificationConfig - - This cmdlet is available only in the cloud-based service. - Use the Get-DataClassificationConfig cmdlet to view the data classification configuration for your organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DataClassificationConfig - - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-DataClassificationConfig - - This example returns the data classification configuration for your organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dataclassificationconfig - - - - - - Get-DataRetentionReport - Get - DataRetentionReport - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-DataRetentionReport cmdlet to view information about data retention in the Security & Compliance Center. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The following properties are returned by this cmdlet: - - Organization - - Date - - Action - - DataSource - - MessageCount - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DataRetentionReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-DataRetentionReport -StartDate 04/01/2018 -EndDate 04/30/2018 - - This example lists the data detections for April, 2018. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dataretentionreport - - - - - - Get-DlpDetailReport - Get - DlpDetailReport - - This cmdlet is available only in the cloud-based service. - Use the Get-DlpDetailReport cmdlet to list details about Data Loss Prevention (DLP) rule matches for Exchange Online, SharePoint Online, and OneDrive for Business in your cloud-based organization for the last 30 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport)cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DlpDetailReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlpdetailreport - - - - - - Get-DlpDetectionsReport - Get - DlpDetectionsReport - - This cmdlet is available only in the cloud-based service. - Use the Get-DlpDetectionsReport cmdlet to list a summary of Data Loss Prevention (DLP) rule matches for Exchange Online, SharePoint Online and OneDrive for Business in your cloud-based organization for the last 30 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DlpDetectionsReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - - String - - String - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - - String - - String - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-DlpDetectionsReport -StartDate 11/01/2018 -EndDate 11/30/2018 - - This example lists the DLP activities for November, 2018. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport - - - - - - Get-DlpSiDetectionsReport - Get - DlpSiDetectionsReport - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-DlpSiDetectionsReport cmdlet to view information about data loss prevention (DLP) sensitive information type detections in the Security & Compliance Center. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For 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 `<GUID>` with the GUID value and run this command: `Get-DlpSensitiveInformationType -Identity <GUID>`. - - 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 `<GUID>` with the GUID value and run this command: `Get-DlpComplianceRule -Identity <GUID>`. - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DlpSiDetectionsReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-DLPSiDetectionsReport - - This example returns all DLP sensitive information type detections. - - - - -------------------------- Example 2 -------------------------- - Get-DLPSiDetectionsReport -SensitiveType 0e9b3178-9678-47dd-a509-37222ca96b42 -StartDate 4/1/2019 -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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlpsidetectionsreport - - - - - - Get-GroupActivityReport - Get - GroupActivityReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-GroupActivityReport cmdlet to view the number of distribution groups that were created and deleted in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-GroupActivityReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-groupactivityreport - - - - - - Get-HistoricalSearch - Get - HistoricalSearch - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A historical search provides message trace and report details in a comma-separated value (CSV) file for messages that are less than 90 days old. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-HistoricalSearch - - JobId - - The JobId parameter specifies the GUID identifier of the historical search that you want to view. - - Guid - - Guid - - - None - - - - - - JobId - - The JobId parameter specifies the GUID identifier of the historical search that you want to view. - - Guid - - Guid - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-historicalsearch - - - - - - Get-LicenseVsUsageSummaryReport - Get - LicenseVsUsageSummaryReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-LicenseVsUsageSummaryReport cmdlet to retrieve a report that identifies the number of active users for installed software licenses (workloads). Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet produces a report that is intended to enable clients to track and manage the use of contracted software licenses. The output contains the following properties. - - Date: The period being measured. - - TenantGuid: The unique identifier for the Exchange Online tenant. - - Workload: The workload whose users are being counted. The current workloads include: Exchange Online, SharePoint Online, Skype for Business Online, and Microsoft Yammer. - - NonTrialEntitlements: The number of entitled users for the workload. - - TrialEntitlements: The number of provisionally entitled (trial) users for the workload. - - ActiveUsers: The count of active users for the workload. - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-LicenseVsUsageSummaryReport - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-LicenseVsUsageSummaryReport - - This example gets a report of the active workload users. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-licensevsusagesummaryreport - - - - - - Get-MailboxActivityReport - Get - MailboxActivityReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-MailboxActivityReport cmdlet to view the number of mailboxes created and deleted in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxActivityReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxactivityreport - - - - - - Get-MailboxStatistics - Get - MailboxStatistics - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxStatistics - - 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) - - GeneralMailboxOrMailUserIdParameter - - GeneralMailboxOrMailUserIdParameter - - - None - - - Archive - - The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - GeneralMailboxOrMailUserIdParameter - - GeneralMailboxOrMailUserIdParameter - - - None - - - Archive - - The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxstatistics - - - - - - Get-MailboxUsageDetailReport - Get - MailboxUsageDetailReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-MailboxUsageDetailReport cmdlet to view usage details about mailboxes in your organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxUsageDetailReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxusagedetailreport - - - - - - Get-MailboxUsageReport - Get - MailboxUsageReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-MailboxUsageReport cmdlet to view the number of mailboxes in your organization that are within 25% of the maximum mailbox size, and the number of mailboxes that are over the maximum size for your organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailboxUsageReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailboxusagereport - - - - - - Get-MailDetailATPReport - Get - MailDetailATPReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 - - Sender Address - - Recipient Address - - Event 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailDetailATPReport - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured 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". - - DateTime - - DateTime - - - None - - - EventType - - The EventType parameter filters the report by the event type. Valid values are: - Email phishing EventTypes: - - Advanced phish filter (Indicates a message caught by the machine learning model.) - - Anti-spoof: Intra-org (Indicates an internal message caught by anti-phish spoof protection.) - - Anti-spoof: external domain (Indicates an external message caught by anti-phish spoof protection.) - - ATP-generated URL reputation* (Indicates a message with a known malicious URL caught Defender for Office 365.) - - Domain impersonation* (Indicates a message impersonating a domain protected by an anti-phish policy.) - - Brand impersonation (Indicates a message caught by phish filters as impersonating a known brand.) - - EOP URL Reputation (Indicates a message with a known malicious URL caught by EOP.) - - General phish filter (Indicates a message caught by basic phish protection.) - - Malicious URL reputation (Indicates a message with a known malicious URL caught by phish filters.) - - Phish ZAP (Indicates a phish or spam message detected and auto-purged after delivery.) - - User impersonation* (Indicates a message impersonating a user protected by an anti-phish policy.) - - Email malware EventTypes: - - Anti-malware engine* (Indicates a message caught by the anti-malware engine.) - - Anti-malware policy file type block (Indicates when the Common Attachment Types filter blocks a file.) - - ATP-generated file reputation* (Indicates a message with a known malicious file blocked Defender for Office 365.) - - ATP Safe Attachments* (Indicates a message with a malicious attachment blocked Defender for Office 365.) - - ATP Safe Links* (Indicates when a malicious link is blocked Defender for Office 365.) - - File Detonation* (Indicates a message with a malicious attachment blocked by the detonation service.) - - Malware ZAP (Indicates a message with malware detected and auto-purged after delivery.) - - Office 365 file reputation (Indicates a message with a known malicious file blocked.) - - Content malware EventTypes: - - AtpDocumentMalware* (Indicates malicious content detected by Safe Attachments.) - - AvDocumentMalware (Indicates malware found by the anti-malware engine. Reporting requires Defender for Office 365 or E5.) - - * Requires Defender for Office 365 (included in Microsoft 365 E5 or in an add-in subscription). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". - - DateTime - - DateTime - - - None - - - - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured 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". - - DateTime - - DateTime - - - None - - - EventType - - The EventType parameter filters the report by the event type. Valid values are: - Email phishing EventTypes: - - Advanced phish filter (Indicates a message caught by the machine learning model.) - - Anti-spoof: Intra-org (Indicates an internal message caught by anti-phish spoof protection.) - - Anti-spoof: external domain (Indicates an external message caught by anti-phish spoof protection.) - - ATP-generated URL reputation* (Indicates a message with a known malicious URL caught Defender for Office 365.) - - Domain impersonation* (Indicates a message impersonating a domain protected by an anti-phish policy.) - - Brand impersonation (Indicates a message caught by phish filters as impersonating a known brand.) - - EOP URL Reputation (Indicates a message with a known malicious URL caught by EOP.) - - General phish filter (Indicates a message caught by basic phish protection.) - - Malicious URL reputation (Indicates a message with a known malicious URL caught by phish filters.) - - Phish ZAP (Indicates a phish or spam message detected and auto-purged after delivery.) - - User impersonation* (Indicates a message impersonating a user protected by an anti-phish policy.) - - Email malware EventTypes: - - Anti-malware engine* (Indicates a message caught by the anti-malware engine.) - - Anti-malware policy file type block (Indicates when the Common Attachment Types filter blocks a file.) - - ATP-generated file reputation* (Indicates a message with a known malicious file blocked Defender for Office 365.) - - ATP Safe Attachments* (Indicates a message with a malicious attachment blocked Defender for Office 365.) - - ATP Safe Links* (Indicates when a malicious link is blocked Defender for Office 365.) - - File Detonation* (Indicates a message with a malicious attachment blocked by the detonation service.) - - Malware ZAP (Indicates a message with malware detected and auto-purged after delivery.) - - Office 365 file reputation (Indicates a message with a known malicious file blocked.) - - Content malware EventTypes: - - AtpDocumentMalware* (Indicates malicious content detected by Safe Attachments.) - - AvDocumentMalware (Indicates malware found by the anti-malware engine. Reporting requires Defender for Office 365 or E5.) - - * Requires Defender for Office 365 (included in Microsoft 365 E5 or in an add-in subscription). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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.) - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-maildetailatpreport - - - - - - Get-MailDetailDlpPolicyReport - Get - MailDetailDlpPolicyReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailDetailDlpPolicyReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-maildetaildlppolicyreport - - - - - - Get-MailDetailMalwareReport - Get - MailDetailMalwareReport - - 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 the last 10 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailDetailMalwareReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-maildetailmalwarereport - - - - - - Get-MailDetailSpamReport - Get - MailDetailSpamReport - - This cmdlet is available only in the cloud-based service. - Use the Get-MailDetailSpamReport cmdlet to view the details of spam messages for the last 10 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailDetailSpamReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-maildetailspamreport - - - - - - Get-MailDetailTransportRuleReport - Get - MailDetailTransportRuleReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailDetailTransportRuleReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - This parameter can´t be older than 30 days from the current day. - - DateTime - - DateTime - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - This parameter can´t be older than 30 days from the current day. - - DateTime - - DateTime - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-maildetailtransportrulereport - - - - - - Get-MailFilterListReport - Get - MailFilterListReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailFilterListReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - SelectionTarget - - The SelectionTarget parameter filters the report information by object type. Valid values are: - - Actions - - DlpPolicy - - DlpRule - - Domain - - EventTypes - - FindOnPremConnector - - TransportRule - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - SelectionTarget - - The SelectionTarget parameter filters the report information by object type. Valid values are: - - Actions - - DlpPolicy - - DlpRule - - Domain - - EventTypes - - FindOnPremConnector - - TransportRule - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MailFilterListReport -SelectionTarget TransportRule - - This example uses the Get-MailFilterListReport cmdlet to return information about transport rules. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailfilterlistreport - - - - - - Get-MailflowStatusReport - Get - MailflowStatusReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailflowStatusReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Domain - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Page - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - PageSize - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Domain - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Page - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - PageSize - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailflowstatusreport - - - - - - Get-MailTrafficATPReport - Get - MailTrafficATPReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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: - - Domain - - Date - - Event Type - - Direction - - Action - - SubType - - Policy Source - - Verdict Source - - Delivery Status - - Message Count - - To see all of these columns (width issues), write the output to a file. For example, `Get-MailTrafficATPReport | Out-String -Width 4096 | Out-File "C:\Users\admin\Desktop\Mail Traffic ATP Report.txt"`. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailTrafficATPReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - EventType - - The EventType parameter filters the report by the event type. Valid values are: - - Message passed (Indicates a good message.) - Email phishing EventTypes: - - Advanced phish filter (Indicates a message caught by the machine learning model.) - - Anti-spoof: Intra-org (Indicates an internal message caught by anti-phish spoof protection.) - - Anti-spoof: external domain (Indicates an external message caught by anti-phish spoof protection.) - - Dmarc (Indicates a message for which the sender was marked as not authenticated by DMARC.) - - Domain impersonation* (Indicates a message impersonating a domain protected by an anti-phish policy.) - - User impersonation* (Indicates a message impersonating a user protected by an anti-phish policy.) - - Brand impersonation (Indicates a message caught by phish filters as impersonating a known brand.) - - General phish filter (Indicates a message caught by basic phish protection.) - - Malicious URL reputation (Indicates a message with a known malicious URL caught by phish filters.) - - Phish ZAP (Indicates a phish or spam message detected and auto-purged after delivery.) - - Email malware EventTypes: - - Anti-malware engine (Indicates a message caught by the anti-malware engine.) - - ATP Safe Attachments* (Indicates a message with a malicious attachment blocked by Defender for Office 365.) - - ATP Safe Links* (Indicates when a malicious link is blocked by Defender for Office 365.) - - ZAP (Indicates a message with malware detected and auto-purged after delivery.) - - Office 365 file reputation (Indicates a message with a known malicious file blocked.) - - Anti-malware policy file type block (Indicates when the Common Attachment Types filter blocks a file.) - - Content malware EventTypes: - - AtpDocumentMalware* (Indicates malicious content detected by Safe Attachments.) - - AvDocumentMalware (Indicates malware found by the anti-malware engine. Reporting requires Defender for Office 365 or E5.) - - * Requires Defender for Office 365 (included in Microsoft 365 E5 or in an add-in subscription). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - EventType - - The EventType parameter filters the report by the event type. Valid values are: - - Message passed (Indicates a good message.) - Email phishing EventTypes: - - Advanced phish filter (Indicates a message caught by the machine learning model.) - - Anti-spoof: Intra-org (Indicates an internal message caught by anti-phish spoof protection.) - - Anti-spoof: external domain (Indicates an external message caught by anti-phish spoof protection.) - - Dmarc (Indicates a message for which the sender was marked as not authenticated by DMARC.) - - Domain impersonation* (Indicates a message impersonating a domain protected by an anti-phish policy.) - - User impersonation* (Indicates a message impersonating a user protected by an anti-phish policy.) - - Brand impersonation (Indicates a message caught by phish filters as impersonating a known brand.) - - General phish filter (Indicates a message caught by basic phish protection.) - - Malicious URL reputation (Indicates a message with a known malicious URL caught by phish filters.) - - Phish ZAP (Indicates a phish or spam message detected and auto-purged after delivery.) - - Email malware EventTypes: - - Anti-malware engine (Indicates a message caught by the anti-malware engine.) - - ATP Safe Attachments* (Indicates a message with a malicious attachment blocked by Defender for Office 365.) - - ATP Safe Links* (Indicates when a malicious link is blocked by Defender for Office 365.) - - ZAP (Indicates a message with malware detected and auto-purged after delivery.) - - Office 365 file reputation (Indicates a message with a known malicious file blocked.) - - Anti-malware policy file type block (Indicates when the Common Attachment Types filter blocks a file.) - - Content malware EventTypes: - - AtpDocumentMalware* (Indicates malicious content detected by Safe Attachments.) - - AvDocumentMalware (Indicates malware found by the anti-malware engine. Reporting requires Defender for Office 365 or E5.) - - * Requires Defender for Office 365 (included in Microsoft 365 E5 or in an add-in subscription). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficatpreport - - - - - - Get-MailTrafficPolicyReport - Get - MailTrafficPolicyReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailTrafficPolicyReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficpolicyreport - - - - - - Get-MailTrafficReport - Get - MailTrafficReport - - 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 90 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For the reporting period you specify, the cmdlet returns the following information: - - Domain (note that this value is populated only when you use the Domain parameter) - - Date - - Event Type - - Direction - - Action - - Message Count - - Recipient Count - - You can use the EventType values from the Get-MailTrafficReport cmdlet to analyze what happened to messages when they were filtered by the service. The following list describes the event types for messages. - Mail traffic summary - - AdvancedProtectionMalware: Messages that were marked as malware by Microsoft Defender for Office 365. For details about Defender for Office 365, see Microsoft Defender for Office 365 service description (https://docs.microsoft.com/office365/servicedescriptions/office-365-advanced-threat-protection-service-description). - AtpGoodMail: Messages that were delivered after passing through Defender for Office 365. This count shows the number of unique messages. If a message was delivered to multiple recipients, it would still count as a single message. - - DLPMessages: Messages that matched a data loss prevention (DLP) policy. For details about data loss prevention, see Overview of data loss prevention (https://docs.microsoft.com/microsoft-365/compliance/data-loss-prevention-policies). - Expire: Messages that cannot be delivered, stuck in a queue, and after some time expired. - - 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. - - Receive: Messages successfully received by the service. - - SpoofMail: Messages that were marked as spoofed by anti-spoofing protection. - - TransportRuleHits: Messages that matched a transport rule. If a message matched multiple rules, this event type would show each of the rule matches. - - TransportRuleMessages: Messages that matched a transport 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 options (https://docs.microsoft.com/microsoft-365/security/office-365-security/advanced-spam-filtering-asf-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://docs.microsoft.com/microsoft-365/security/office-365-security/configure-your-spam-filter-policies). - 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://docs.microsoft.com/microsoft-365/security/office-365-security/what-s-the-difference-between-junk-email-and-bulk-email). - 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 options (https://docs.microsoft.com/microsoft-365/security/office-365-security/advanced-spam-filtering-asf-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://docs.microsoft.com/microsoft-365/security/office-365-security/configure-your-spam-filter-policies). - 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 mail flow rules to configure bulk email filtering in Exchange Online Protection (https://docs.microsoft.com/microsoft-365/security/office-365-security/use-transport-rules-to-configure-bulk-email-filtering). - BCL1 through BCL9: Messages with BCL rating of 1 through 9. - Encryption - - EncryptionManual: Messages manually encrypted by users. - - EncryptionPolicy: Messages that matched a rule for encrypting email messages using the latest Office 365 Message Encryption (OME) capabilities. - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailTrafficReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - Valid values are: - - Action - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - Valid values are: - - Action - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 EventType | Format-Table Domain,Date,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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficreport - - - - - - Get-MailTrafficSummaryReport - Get - MailTrafficSummaryReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailTrafficSummaryReport - - Category - - The Category parameter filters the report by category. Valid values for this parameter are: InboundDLPHits, OutboundDLPHits, InboundTransportRuleHits, OutboundTransportRuleHits, InboundDLPPolicyRuleHits, OutboundDLPPolicyRuleHits, TopSpamRecipient, TopMailSender, TopMailRecipient, TopMalwareRecipient or TopMalware. - - String - - String - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - Category - - The Category parameter filters the report by category. Valid values for this parameter are: InboundDLPHits, OutboundDLPHits, InboundTransportRuleHits, OutboundTransportRuleHits, InboundDLPPolicyRuleHits, OutboundDLPPolicyRuleHits, TopSpamRecipient, TopMailSender, TopMailRecipient, TopMalwareRecipient or TopMalware. - - String - - String - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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 ("). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficsummaryreport - - - - - - Get-MailTrafficTopReport - Get - MailTrafficTopReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For the reporting period you specify, the cmdlet returns the following information: - - Domain - - Date - - Name - - Event Type - - Direction - - Count - - To see all of these columns (width issues), write the output to a file. For example, `Get-MailTrafficTopReport | Out-String -Width 4096 | Out-File "C:\Users\admin\Desktop\Mail Traffic Top Report.txt"`. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailTrafficTopReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - Valid values are: - - Domain - - EventType - - You can specify multiple values separated by commas. The values that you specify for this parameter are not displayed in the results (the values in the corresponding columns are blank). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AggregateBy - - The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - - String - - String - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - Valid values are: - - Domain - - EventType - - You can specify multiple values separated by commas. The values that you specify for this parameter are not displayed in the results (the values in the corresponding columns are blank). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailtraffictopreport - - - - - - Get-MessageTrace - Get - MessageTrace - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MessageTrace - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - String - - String - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Guid - - Guid - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - String - - String - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Guid - - Guid - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-messagetrace - - - - - - Get-MessageTraceDetail - Get - MessageTraceDetail - - This cmdlet is available only in the cloud-based service. - Use the Get-MessageTraceDetail cmdlet to view the message trace event details for a specific message. Note that these detailed results are returned less quickly than the Get-MessageTrace results. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MessageTraceDetail - - 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. - - Guid - - Guid - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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>"). - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - 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. - - Guid - - Guid - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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>"). - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MessageTraceDetail -MessageTraceId ae5c1219-4c90-41bf-fef5-08d837917e7c -RecipientAddress robert@contoso.com - - This example uses the Get-MessageTraceDetail cmdlet to retrieve detailed message trace information for messages with the Exchange Network Message ID value ae5c1219-4c90-41bf-fef5-08d837917e7c received by robert@contoso.com. - - - - -------------------------- Example 2 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-messagetracedetail - - - - - - Get-MxRecordReport - Get - MxRecordReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MxRecordReport - - Domain - - The Domain parameter specifies the domain you want to test. - - Fqdn - - Fqdn - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - - - - Domain - - The Domain parameter specifies the domain you want to test. - - Fqdn - - Fqdn - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MxRecordReport -Domain contoso.com - - This example shows the MX record information for the contoso.com domain. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mxrecordreport - - - - - - Get-O365ClientBrowserDetailReport - Get - O365ClientBrowserDetailReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-O365ClientBrowserDetailReport cmdlet to get a detailed report of client browser use. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This report provides browser details for all active users. The data contains a maximum of four browsers per user, and are aggregated daily and retained for 5 days. The properties that are returned in the results are described in the following list. - - TenantGuid: Unique identifier of the tenant. - - TenantName: Tenant name. - - Date: The timestamp for the connection for the browser and version combination. - - WindowsLiveID: User ID in the format user@domain. - - DisplayName: User name. - - LastAccessTime: Last date the user connected with this browser and version combination. - - ObjectId: User object ID. - - Browser: Browser name. - - BrowserVersion: Browser version. - - BrowserUsageCount: Number of days this browser and version combination was used during the period of the report - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-O365ClientBrowserDetailReport - - 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 - - String - - String - - - None - - - 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. - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - WindowsLiveID - - The WindowsLiveID parameter filters the report by user ID. - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - 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. - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - WindowsLiveID - - The WindowsLiveID parameter filters the report by user ID. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-o365clientbrowserdetailreport - - - - - - Get-O365ClientBrowserReport - Get - O365ClientBrowserReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-O365ClientBrowserReport cmdlet to get a summary report of client browser use. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The report displays the client use statistics for the five most recent versions of the browsers named in the Browser parameter description. All previous browser versions are combined into a sixth category named Others. The following list describes the properties that are returned in the results. - - TenantGuid: Unique identifier of the tenant. - - TenantName: Tenant name. - - Date: Last time the line item data was aggregated. - - Browser: Browser name. - - Version: Browser version. - - TotalBrowserCount: Number of times a given browser and version combination connected to the service during the reporting period. - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-O365ClientBrowserReport - - 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 - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - 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 - - String - - String - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-o365clientbrowserreport - - - - - - Get-O365ClientOSDetailReport - Get - O365ClientOSDetailReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-O365ClientOSDetailReport cmdlet to get a detailed report of client operating system use. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This report provides operating system details for all active users. The data contains a maximum of four operating systems per user, are aggregated daily and retained for 5 days. The properties that are returned in the results are described in the following list. - - TenantGuid: Unique identifier of the tenant. - - TenantName: Tenant name. - - Date: The timestamp for the connection for the operating system and version combination. - - WindowsLiveID: User ID in the format user@domain. - - DisplayName: User name. - - LastAccessTime: Last date the user connected with this operating system and version combination. - - ObjectId: User object ID. - - OperatingSystem: Operating system name. - - Version: Operating system version. - - OperatingSystemUsageCount: Number of days this operating system and version combination was used during the period of the report - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-O365ClientOSDetailReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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" - - String - - String - - - None - - - OperatingSystemVersion - - The OperatingSystemVersion parameter filters the report by operating system version. If you don't use this parameter, all operating system versions will be included. The parameter accepts version numbers up to the first minor version. For example, use 6 or 6.1, not 6.1.9600. Wildcards are not accepted. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - WindowsLiveID - - The WindowsLiveID filters the report by user ID. - - String - - String - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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" - - String - - String - - - None - - - OperatingSystemVersion - - The OperatingSystemVersion parameter filters the report by operating system version. If you don't use this parameter, all operating system versions will be included. The parameter accepts version numbers up to the first minor version. For example, use 6 or 6.1, not 6.1.9600. Wildcards are not accepted. - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - WindowsLiveID - - The WindowsLiveID filters the report by user ID. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-o365clientosdetailreport - - - - - - Get-O365ClientOSReport - Get - O365ClientOSReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-O365ClientOSReport cmdlet to get a summary report of client operating system use. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The report displays the client use statistics for the five most recent versions of the operating systems named in the OS parameter description. All previous operating system versions are combined into a sixth category named Others. The following list describes the properties that are returned in the results. - - TenantGuid: Unique identifier of the tenant. - - TenantName: Tenant name. - - Date: Last time the line item data was aggregated. - - OperatingSystem: Operating system name. - - Version: Operating system version. - - OperatingSystemUsageCount: Number of times a given operating system and version combination connected to the service during the reporting period. - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-O365ClientOSReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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" - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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" - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-o365clientosreport - - - - - - Get-OrganizationalUnit - Get - OrganizationalUnit - - This cmdlet is available in 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-OrganizationalUnit cmdlet to view a list of organizational units (OUs) that exist in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-OrganizationalUnit cmdlet is used by the Exchange admin center to populate fields that display OU information. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OrganizationalUnit - - Identity - - 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. - - ExtendedOrganizationalUnitIdParameter - - ExtendedOrganizationalUnitIdParameter - - - None - - - IncludeContainers - - The IncludeContainers switch instructs the command to return containers in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - SingleNodeOnly - - The SingleNodeOnly switch instructs the command to return only the first level child OUs beneath the OU specified in the Identity parameter. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - Get-OrganizationalUnit - - IncludeContainers - - The IncludeContainers switch instructs the command to return containers in the results. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - SearchText - - The SearchText parameter enables you to search the names of all OUs in your organization for the specified string. Only the OUs that match the string you specify are returned. If the string you specify contains spaces, enclose it in quotation marks ("). - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - - - - Identity - - 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. - - ExtendedOrganizationalUnitIdParameter - - ExtendedOrganizationalUnitIdParameter - - - None - - - IncludeContainers - - The IncludeContainers switch instructs the command to return containers in the results. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - SingleNodeOnly - - The SingleNodeOnly switch instructs the command to return only the first level child OUs beneath the OU specified in the Identity parameter. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - SearchText - - The SearchText parameter enables you to search the names of all OUs in your organization for the specified string. Only the OUs that match the string you specify are returned. If the string you specify contains spaces, enclose it in quotation marks ("). - You can't use this parameter with the Identity parameter. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - -------------------------- Example 2 -------------------------- - 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 About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-organizationalunit - - - - - - Get-OutboundConnectorReport - Get - OutboundConnectorReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OutboundConnectorReport - - Domain - - The Domain parameter specifies the domain you want to test. - - Fqdn - - Fqdn - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - - - - Domain - - The Domain parameter specifies the domain you want to test. - - Fqdn - - Fqdn - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-OutboundConnectorReport -Domain contoso.com - - This example shows the Outbound connector that's used to deliver mail to the contoso.com domain. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-outboundconnectorreport - - - - - - Get-QuarantineMessage - Get - QuarantineMessage - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-QuarantineMessage - - 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`. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - - Get-QuarantineMessage - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid are Inbound and Outbound. - - QuarantineMessageDirectionEnum - - QuarantineMessageDirectionEnum - - - None - - - Domain - - The Domain parameter filters the results by sender or recipient domain. You can specify multiple domain values separated by commas. - - String[] - - String[] - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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>"`). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - QuarantineTypes - - The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: - - Bulk - - HighConfPhish - - Malware - - 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 protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. - - QuarantineMessageTypeEnum[] - - QuarantineMessageTypeEnum[] - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 ("). - - String - - String - - - None - - - Type - - The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - - Bulk - - HighConfPhish - - 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. - - QuarantineMessageTypeEnum - - QuarantineMessageTypeEnum - - - None - - - - - - 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`. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - Direction - - The Direction parameter filters the results by incoming or outgoing messages. Valid are Inbound and Outbound. - - QuarantineMessageDirectionEnum - - QuarantineMessageDirectionEnum - - - None - - - Domain - - The Domain parameter filters the results by sender or recipient domain. You can specify multiple domain values separated by commas. - - String[] - - String[] - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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>"`). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - QuarantineTypes - - The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: - - Bulk - - HighConfPhish - - Malware - - 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 protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. - - QuarantineMessageTypeEnum[] - - QuarantineMessageTypeEnum[] - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SenderAddress - - The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - 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. - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 ("). - - String - - String - - - None - - - Type - - The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - - Bulk - - HighConfPhish - - 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. - - QuarantineMessageTypeEnum - - QuarantineMessageTypeEnum - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-quarantinemessage - - - - - - Get-QuarantineMessageHeader - Get - QuarantineMessageHeader - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Standard SMTP message header syntax is described in RFC 5322. This cmdlet displays the message header exactly as it appears in the message. Individual header fields are not unfolded. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-QuarantineMessageHeader - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - - - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-quarantinemessageheader - - - - - - Get-RecipientStatisticsReport - Get - RecipientStatisticsReport - - This cmdlet is available only in the cloud-based service. - Use the Get-RecipientStatisticsReport cmdlet to view the recipient statistics report. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The recipient statistics report provides information about the total number of mailboxes and the total number of active mailboxes in the organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RecipientStatisticsReport - - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-RecipientStatisticsReport - - This example displays the recipient statistics report for the organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-recipientstatisticsreport - - - - - - Get-ReportExecutionInstance - Get - ReportExecutionInstance - - This cmdlet is available only in the cloud-based service. - Use the Get-ReportExecutionInstance cmdlet to review the report execution instance in Exchange Online. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ReportExecutionInstance - - Identity - - The Identity parameter specifies the report execution instance that you want to view. The identity of the instance is a unique GUID value. - - InstanceIdParameter - - InstanceIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - Identity - - The Identity parameter specifies the report execution instance that you want to view. The identity of the instance is a unique GUID value. - - InstanceIdParameter - - InstanceIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-reportexecutioninstance - - - - - - Get-SafeLinksAggregateReport - Get - SafeLinksAggregateReport - - This cmdlet is available only in the cloud-based service. - Use the Get-SafeLinksAggregateReport cmdlet to return to return general information about Safe Links results for the last 90 days. Yesterday is the most recent date that you can specify. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 (Allowed, Blocked, ClickedEventBlocked, and ClickedDuringScan) - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SafeLinksAggregateReport - - Action - - The Action parameter filters the results by action. Valid values are: - - Allowed - - Blocked - - ClickedEvenBlocked - - ClickedDuringScan - - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AppNameList - - The AppNameList parameter filters the results by the app where the link was found. Valid values are: - - Email Client - - Excel - - OneNote - - Others - - Outlook - - PowerPoint - - Teams - - Visio - - Word - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - SummarizeBy - - The SummarizeBy parameter returns totals based on the values you specify. 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. - - 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. - - String - - String - - - None - - - - - - Action - - The Action parameter filters the results by action. Valid values are: - - Allowed - - Blocked - - ClickedEvenBlocked - - ClickedDuringScan - - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AppNameList - - The AppNameList parameter filters the results by the app where the link was found. Valid values are: - - Email Client - - Excel - - OneNote - - Others - - Outlook - - PowerPoint - - Teams - - Visio - - Word - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - SummarizeBy - - The SummarizeBy parameter returns totals based on the values you specify. 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. - - 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. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-safelinksaggregatereport - - - - - - Get-SafeLinksDetailReport - Get - SafeLinksDetailReport - - This cmdlet is available only in the cloud-based service. - Use the Get-SafeLinksDetailReport cmdlet to return to return detailed information about Safe Links results for the last 7 days. Yesterday is the most recent date that you can specify. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 - - InternalMessageId - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SafeLinksDetailReport - - Action - - The Action parameter filters the results by action. Valid values are: - - Allowed - - Blocked - - ClickedEvenBlocked - - ClickedDuringScan - - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AppNameList - - The AppNameList parameter filters the results by the app where the link was found. Valid values are: - - Email Client - - Excel - - OneNote - - Others - - Outlook - - PowerPoint - - Teams - - Visio - - Word - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Domain - - The Domain parameter filters the results by the domain in the URL. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - - - - Action - - The Action parameter filters the results by action. Valid values are: - - Allowed - - Blocked - - ClickedEvenBlocked - - ClickedDuringScan - - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AppNameList - - The AppNameList parameter filters the results by the app where the link was found. Valid values are: - - Email Client - - Excel - - OneNote - - Others - - Outlook - - PowerPoint - - Teams - - Visio - - Word - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Domain - - The Domain parameter filters the results by the domain in the URL. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - RecipientAddress - - The RecipientAddress parameter filters the results by the recipient's email address. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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. - - System.DateTime - - System.DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-safelinksdetailreport - - - - - - Get-SCInsights - Get - SCInsights - - This cmdlet is available only in the cloud-based service. - Use the Get-SCInsights cmdlet to view Microsoft 365 insights information. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet returns the following output: - - Organization: The Microsoft 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SCInsights - - 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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - - - - 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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-scinsights - - - - - - Get-SearchDocumentFormat - Get - SearchDocumentFormat - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Exchange Search includes built-in support for indexing many file formats. Output from the Get-SearchDocumentFormat cmdlet includes details about each supported file format, including whether content indexing is enabled for the file format, the format handler and the file extension (such as .docx). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SearchDocumentFormat - - Identity - - The Identity parameter specifies the identity of a file format. - - SearchDocumentFormatId - - SearchDocumentFormatId - - - None - - - - - - Identity - - The Identity parameter specifies the identity of a file format. - - SearchDocumentFormatId - - SearchDocumentFormatId - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-searchdocumentformat - - - - - - Get-SecurityPrincipal - Get - SecurityPrincipal - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-SecurityPrincipal cmdlet is used by the Exchange admin center to populate fields that display recipient information. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SecurityPrincipal - - 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. - - ExtendedSecurityPrincipalIdParameter - - ExtendedSecurityPrincipalIdParameter - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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 - - ExtendedOrganizationalUnitIdParameter - - ExtendedOrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - ExtendedSecurityPrincipalIdParameter - - ExtendedSecurityPrincipalIdParameter - - - None - - - 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 - - ExtendedOrganizationalUnitIdParameter - - ExtendedOrganizationalUnitIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-securityprincipal - - - - - - Get-ServiceDeliveryReport - Get - ServiceDeliveryReport - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ServiceDeliveryReport - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Recipient - - The Recipient parameter specifies the email address of the recipient you want to test. - - SmtpAddress - - SmtpAddress - - - None - - - - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Recipient - - The Recipient parameter specifies the email address of the recipient you want to test. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ServiceDeliveryReport -Recipient chris@contoso.com - - This example shows the delivery path information for the recipient chris@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-servicedeliveryreport - - - - - - Get-SmimeConfig - Get - SmimeConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SmimeConfig - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-SmimeConfig - - This example shows the S/MIME configuration that's used with Outlook on the web. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-smimeconfig - - - - - - Get-SPOActiveUserReport - Get - SPOActiveUserReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-SpoActiveUserReport cmdlet to view statistics about Microsoft SharePoint Online users in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SPOActiveUserReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-spoactiveuserreport - - - - - - Get-SpoofMailReport - Get - SpoofMailReport - - 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 for the past 10 days. 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 Microsoft 365 Enterprise E5 or Microsoft Defender for Office 365 licenses. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The spoof mail report is a feature in Defender for Office 36 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SpoofMailReport - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming messages. The valid value for this parameter is Inbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Direction - - The Direction parameter filters the results by incoming messages. The valid value for this parameter is Inbound. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Expression - - This parameter is reserved for internal Microsoft use. - - Expression - - Expression - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ProbeTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-spoofmailreport - - - - - - Get-SPOSkyDriveProDeployedReport - Get - SPOSkyDriveProDeployedReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-SPOSkyDriveProDeployedReport cmdlet to view the number of My Site sites in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SPOSkyDriveProDeployedReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-sposkydriveprodeployedreport - - - - - - Get-SPOSkyDriveProStorageReport - Get - SPOSkyDriveProStorageReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-SPOSkyDriveProStorageReport cmdlet to view statistics about the space taken up (in MB) by My Sites in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SPOSkyDriveProStorageReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-sposkydriveprostoragereport - - - - - - Get-SPOTeamSiteDeployedReport - Get - SPOTeamSiteDeployedReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-SPOTeamSiteDeployedReport cmdlet to view statistics about the number of team sites in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SPOTeamSiteDeployedReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-spoteamsitedeployedreport - - - - - - Get-SPOTeamSiteStorageReport - Get - SPOTeamSiteStorageReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-SPOTeamSiteStorageReport cmdlet to view statistics about the space taken up (in MB) by team sites in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SPOTeamSiteStorageReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-spoteamsitestoragereport - - - - - - Get-SPOTenantStorageMetricReport - Get - SPOTenantStorageMetricReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-SPOTenantStorageMetricReport cmdlet to view statistics about the space taken up (in MB) by all sites in for your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SPOTenantStorageMetricReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - ReportType - - ReportType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-spotenantstoragemetricreport - - - - - - Get-StaleMailboxDetailReport - Get - StaleMailboxDetailReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-StaleMailboxDetailReport cmdlet to view mailboxes that haven't been accessed for at least 30 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-StaleMailboxDetailReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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" - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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" - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-StaleMailboxDetailReport - - This example retrieves all the mailboxes that haven't been accessed for at least 30 days. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-stalemailboxdetailreport - - - - - - Get-StaleMailboxReport - Get - StaleMailboxReport - - This cmdlet is available only in the cloud-based service. - This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of Working with Microsoft 365 usage reports in Microsoft Graph (https://docs.microsoft.com/graph/api/resources/report). - Use the Get-StaleMailboxReport cmdlet to view the number of mailboxes that haven't been accessed for at least 30 days. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-StaleMailboxReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-StaleMailboxReport - - This example retrieves the number of mailboxes that haven't been accessed for at least 30 days. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-stalemailboxreport - - - - - - Get-SupervisoryReviewOverallProgressReport - Get - SupervisoryReviewOverallProgressReport - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-SupervisoryReviewOverallProgressReport cmdlet to view the total number of supervised communications classified as Pending, Resolved, Compliant, Non-compliant, and Questionable. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-SupervisoryReviewOverallProgressReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-SupervisoryReviewOverallProgressReport | ft Pending, Resolved, Compliant, Noncompliant, Questionable - - This example returns a list of the total number of supervised communications classified by status. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewoverallprogressreport - - - - - - Get-SupervisoryReviewPolicyReport - Get - SupervisoryReviewPolicyReport - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-SupervisoryReviewPolicyReport cmdlet to view supervisory review policy events in the Security & Compliance Center. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-SupervisoryReviewPolicyReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Policies - - The Policies parameter filters the results by the supervisory review policy. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Policies - - The Policies parameter filters the results by the supervisory review policy. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyreport - - - - - - Get-SupervisoryReviewReport - Get - SupervisoryReviewReport - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-SupervisoryReviewReport cmdlet to view supervisory review events in the Security & Compliance Center for the last 90 days. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-SupervisoryReviewReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Policies - - The Policies parameter filters the results by the supervisory review policy. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Reviewers - - The Reviewers parameter filters the results by the reviewers of the supervisory review policy. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Policies - - The Policies parameter filters the results by the supervisory review policy. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Reviewers - - The Reviewers parameter filters the results by the reviewers of the supervisory review policy. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewreport - - - - - - Get-SupervisoryReviewTopCasesReport - Get - SupervisoryReviewTopCasesReport - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-SupervisoryReviewTopCasesReport cmdlet to view the current status of the top supervision policies configured in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-SupervisoryReviewTopCasesReport - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - System.DateTime - - System.DateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewtopcasesreport - - - - - - New-ApplicationAccessPolicy - New - ApplicationAccessPolicy - - This cmdlet is available only in the cloud-based service. - Use the New-ApplicationAccessPolicy cmdlet to restrict or deny access for an application that is using Outlook REST APIs or Microsoft Graph APIs to a specific set of mailboxes. These policies are complimentary to the permission scopes that are declared by the application. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - Use the New-ApplicationAccessPolicy cmdlet to restrict or deny access for an application that is using Outlook REST APIs or Microsoft Graph APIs to a specific set of mailboxes. These policies are complimentary to the permission scopes that are declared by the application. - A limit of 100 policies per Microsoft 365 tenant is enforced as of today. An error message stating "A tenant cannot have more than 100 policies." will be displayed if this number is exceeded. - While the scope-based resource access like Mail.Read or Calendar.Read is effective to ensure that the application can only read mails or events within a mailbox and not do anything else; Application Access Policy feature allows admins to enforce limits that are based on a list of mailboxes. For example, in a global organization apps developed for one country shouldn't have access to data from other countries or a CRM integration application should only access calendar of 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. - - - - New-ApplicationAccessPolicy - - AccessRight - - The AccessRight parameter specifies the permission that you want to assign in the application access policy. Valid values are: - - RestrictAccess - - DenyAccess - - ApplicationAccessPolicyIdParameter - - ApplicationAccessPolicyIdParameter - - - None - - - 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. - - String[] - - String[] - - - None - - - PolicyScopeGroupID - - The PolicyScopeGroupID parameter specifies the recipient to define in the policy. You can use any value that uniquely identifies the recipient. You can also specify a mail enabled security group to restrict/deny access to a large number of user mailboxes. For example: - - Name - - Distinguished name (DN) - - Display name - - Email address - - GUID - - This parameter only accepts recipients that are security principals (users or groups that can have permissions assigned to them). The following types of recipients are not security principals, so you can't use them with this parameter: - - Discovery mailboxes - - Dynamic distribution groups - - Distribution groups - - Shared mailboxes - - To verify that a recipient is a security principal, use the syntax `Get-Recipient -Identity <RecipientIdentity> | Select-Object IsValidSecurityPrincipal`. - If you need to scope the policy to shared mailboxes, you can add them to a mail enabled security group. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - - SwitchParameter - - - False - - - - - - AccessRight - - The AccessRight parameter specifies the permission that you want to assign in the application access policy. Valid values are: - - RestrictAccess - - DenyAccess - - ApplicationAccessPolicyIdParameter - - ApplicationAccessPolicyIdParameter - - - None - - - 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. - - String[] - - String[] - - - None - - - PolicyScopeGroupID - - The PolicyScopeGroupID parameter specifies the recipient to define in the policy. You can use any value that uniquely identifies the recipient. You can also specify a mail enabled security group to restrict/deny access to a large number of user mailboxes. For example: - - Name - - Distinguished name (DN) - - Display name - - Email address - - GUID - - This parameter only accepts recipients that are security principals (users or groups that can have permissions assigned to them). The following types of recipients are not security principals, so you can't use them with this parameter: - - Discovery mailboxes - - Dynamic distribution groups - - Distribution groups - - Shared mailboxes - - To verify that a recipient is a security principal, use the syntax `Get-Recipient -Identity <RecipientIdentity> | Select-Object IsValidSecurityPrincipal`. - If you need to scope the policy to shared mailboxes, you can add them to a mail enabled security group. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - New-ApplicationAccessPolicy -AccessRight RestrictAccess -AppId "e7e4dbfc-046f-4074-9b3b-2ae8f144f59b" -PolicyScopeGroupId EvenUsers@AppPolicyTest2.com -Description "Restrict this app 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 to members of security group EvenUsers. - - - - -------------------------- Example 3 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-applicationaccesspolicy - - - - - - New-MailMessage - New - MailMessage - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If the cmdlet is run without specifying the Subject or Body parameters, an empty email message is placed in the user's Drafts folder. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MailMessage - - Body - - The Body parameter specifies the content of the body section of the new email message. - - String - - String - - - None - - - 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. - - MailBodyFormat - - MailBodyFormat - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Subject - - The Subject parameter specifies the content of the subject field of the new email message. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Body - - The Body parameter specifies the content of the body section of the new email message. - - String - - String - - - None - - - 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. - - MailBodyFormat - - MailBodyFormat - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Subject - - The Subject parameter specifies the content of the subject field of the new email message. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-mailmessage - - - - - - Preview-QuarantineMessage - Preview - QuarantineMessage - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Preview-QuarantineMessage - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - - - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/preview-quarantinemessage - - - - - - Release-QuarantineMessage - Release - QuarantineMessage - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Consider the following scenario: john@gmail.com sends a message to faith@contoso.com and john@subsidiary.contoso.com. Gmail bifurcates this message into two copies that are both routed to quarantine as phishing in Microsoft. An admin releases both of these messages to admin@contoso.com. The first released message that reaches the admin mailbox is delivered. The second released message is identified as duplicate delivery and is skipped. Message are identified as duplicates if they have the same message ID and received time. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Release-QuarantineMessage - - 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. - - QuarantineMessageIdentity[] - - QuarantineMessageIdentity[] - - - None - - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Release-QuarantineMessage - - 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. - - QuarantineMessageIdentity[] - - QuarantineMessageIdentity[] - - - None - - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - ReleaseToAll - - The ReleaseToAll switch releases the quarantined message to all original recipients. You don't need 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 switch again. - You can't use the ReleaseToAll switch and the User parameter in the same command. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Delete - - This parameter has been deprecated and is no longer used. - To delete quarantined messages, use the Delete-QuarantineMessage cmdlet. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Release-QuarantineMessage - - 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. - - QuarantineMessageIdentity[] - - QuarantineMessageIdentity[] - - - None - - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - 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. - - String[] - - String[] - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Release-QuarantineMessage - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - QuarantineMessageIdentity[] - - QuarantineMessageIdentity[] - - - None - - - 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. - - QuarantineMessageIdentity - - QuarantineMessageIdentity - - - None - - - ReleaseToAll - - The ReleaseToAll switch releases the quarantined message to all original recipients. You don't need 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 switch again. - You can't use the ReleaseToAll switch and the User parameter in the same command. - - SwitchParameter - - SwitchParameter - - - 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. - - String[] - - String[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Delete - - This parameter has been deprecated and is no longer used. - To delete quarantined messages, use the Delete-QuarantineMessage cmdlet. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 -ReleaseToAll - - This example releases a file that was quarantined as part of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. The first command stores all quarantined files in the variable $q. The second command releases the last file in the list. For more information about elements in arrays and index numbers, see Accessing and Using Array Elements (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_arrays#accessing-and-using-array-elements). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/release-quarantinemessage - - - - - - Remove-ApplicationAccessPolicy - Remove - ApplicationAccessPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ApplicationAccessPolicy - - 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. - - ApplicationAccessPolicyIdParameter - - ApplicationAccessPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - - SwitchParameter - - - False - - - - - - 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. - - ApplicationAccessPolicyIdParameter - - ApplicationAccessPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-applicationaccesspolicy - - - - - - Set-ApplicationAccessPolicy - Set - ApplicationAccessPolicy - - This cmdlet is available only in the cloud-based service. - Use the Set-ApplicationAccessPolicy cmdlet to modify the description of an application access policy. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This feature applies only to apps connecting to the Microsoft Graph API for Outlook resources. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ApplicationAccessPolicy - - 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. - - ApplicationAccessPolicyIdParameter - - ApplicationAccessPolicyIdParameter - - - None - - - Description - - The Description parameter modifies the description of the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - - SwitchParameter - - - False - - - - - - 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. - - ApplicationAccessPolicyIdParameter - - ApplicationAccessPolicyIdParameter - - - None - - - Description - - The Description parameter modifies the description of the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-applicationaccesspolicy - - - - - - Set-CASMailboxPlan - Set - CASMailboxPlan - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - A CAS mailbox plan is tied to the corresponding mailbox plan that has the same name (and display name). Like mailbox plans, CAS mailbox plans correspond to license types, and are applied to a mailbox when you license the user. The availability of a CAS mailbox plan is determined by your selections when you enroll in the service and the age of your organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-CASMailboxPlan - - 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-<GUID>`, respectively). - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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-<GUID>`, respectively). - - MailboxPlanIdParameter - - MailboxPlanIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-casmailboxplan - - - - - - Set-SmimeConfig - Set - SmimeConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Set-SmimeConfig cmdlet can change several important parameters than can reduce the overall level of message security. Review your organization's security policy before you make any changes. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-SmimeConfig - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - Confirm - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UInt32 - - UInt32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - OWACopyRecipientHeaders - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - UInt32 - - UInt32 - - - None - - - 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. - - UInt32 - - UInt32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UInt32 - - UInt32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Byte[] - - Byte[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - Confirm - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UInt32 - - UInt32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - OWACopyRecipientHeaders - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - UInt32 - - UInt32 - - - None - - - 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. - - UInt32 - - UInt32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - UInt32 - - UInt32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Byte[] - - Byte[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-smimeconfig - - - - - - Start-HistoricalSearch - Start - HistoricalSearch - - This cmdlet is available only in the cloud-based service. - Use the Start-HistoricalSearch cmdlet to start a new historical search. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 50000 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Start-HistoricalSearch - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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. - - DateTime - - DateTime - - - None - - - 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. - - String - - String - - - None - - - 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 - - ATPV2: Exchange Online Protection and Defender for Office 365 Malware detection in email report. - - ATPDocument: Defender for Office 365 Content Malware Report for Safe Attachments for 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 Defender for Office 365 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. - - HistoricalSearchReportType - - HistoricalSearchReportType - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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 - - String - - String - - - None - - - 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. - - MessageDirection - - MessageDirection - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Locale - - The Locale parameter filters the results by the locale of the message. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 . - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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. - - DateTime - - DateTime - - - None - - - 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. - - String - - String - - - None - - - 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 - - ATPV2: Exchange Online Protection and Defender for Office 365 Malware detection in email report. - - ATPDocument: Defender for Office 365 Content Malware Report for Safe Attachments for 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 Defender for Office 365 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. - - HistoricalSearchReportType - - HistoricalSearchReportType - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - 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 - - String - - String - - - None - - - 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. - - MessageDirection - - MessageDirection - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Locale - - The Locale parameter filters the results by the locale of the message. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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>"). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 . - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 "Fabrikam 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/start-historicalsearch - - - - - - Stop-HistoricalSearch - Stop - HistoricalSearch - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Stop-HistoricalSearch - - JobId - - The JobId parameter specifies the identity GUID value of the historical search that you want to stop. - - Guid - - Guid - - - None - - - - - - JobId - - The JobId parameter specifies the identity GUID value of the historical search that you want to stop. - - Guid - - Guid - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/stop-historicalsearch - - - - - - Test-MAPIConnectivity - Test - MAPIConnectivity - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-MAPIConnectivity - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-mapiconnectivity - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.TransportMailControl-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.TransportMailControl-Help.xml deleted file mode 100644 index 982cd5930fcb..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.TransportMailControl-Help.xml +++ /dev/null @@ -1,2636 +0,0 @@ - - - - - Disable-JournalRule - Disable - JournalRule - - This cmdlet is available in 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-JournalRule cmdlet to disable a journal rule on a Mailbox server. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can enable or disable specific journal rules in your organization at any time using the Disable-JournalRule and Enable-JournalRule cmdlets. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-JournalRule - - Identity - - The Identity parameter specifies the journal rule you want to disable. Enter either the name or the GUID of the journal rule. You can omit this parameter label. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the journal rule you want to disable. Enter either the name or the GUID of the journal rule. You can omit this parameter label. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-JournalRule "Brokerage Communications" - - This example disables the journal rule Brokerage Communications. - - - - -------------------------- Example 2 -------------------------- - Get-JournalRule | Disable-JournalRule - - This example disables all journal rules. The Get-JournalRule cmdlet is used to add all journal rules to the pipeline. The results are piped to the Disable-JournalRule cmdlet. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-journalrule - - - - - - Enable-JournalRule - Enable - JournalRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You can enable or disable specific journal rules in your organization at any time using the Enable-JournalRule and Disable-JournalRule cmdlets. For more information, see Journaling in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/journaling/journaling). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-JournalRule - - 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. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-JournalRule "Brokerage Communications" - - This example enables the existing journal rule Brokerage Communications. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-journalrule - - - - - - Get-IRMConfiguration - Get - IRMConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-IRMConfiguration cmdlet provides details about the current IRM configuration, including whether individual IRM features are enabled or disabled and provides the URLs used for ServiceLocation, PublishingLocation and LicensingLocation. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-IRMConfiguration - - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-IRMConfiguration - - This example retrieves the IRM configuration in your organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-irmconfiguration - - - - - - Get-JournalRule - Get - JournalRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-JournalRule cmdlet displays journal rules configured in your organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-JournalRule - - 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. - - RuleIdParameter - - RuleIdParameter - - - None - - - - - - 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. - - RuleIdParameter - - RuleIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-journalrule - - - - - - Get-OrganizationSegment - Get - OrganizationSegment - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-OrganizationSegment cmdlet to view organization segments in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Segments are defined by using certain attributes (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes)in Azure Active Directory. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-OrganizationSegment - - Identity - - The Identity parameter specifies the organization segment that you want to view. You can use any value that uniquely identifies the segment. For example: - - Name - - Distinguished name (DN) - - GUID - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the organization segment that you want to view. You can use any value that uniquely identifies the segment. For example: - - Name - - Distinguished name (DN) - - GUID - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-OrganizationSegment | Format-List Name,UserGroupFilter - - This example returns a summary list of all organization segments. - - - - -------------------------- Example 2 -------------------------- - Get-OrganizationSegment -Identity "Engineering Group" - - This example returns detailed information about the organization segment named Engineering Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-organizationsegment - - - Attributes for information barrier policies - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - New-InformationBarrierPolicy - https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy - - - - - - Get-RMSTemplate - Get - RMSTemplate - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-RMSTemplate cmdlet doesn't return any active rights policy templates if internal licensing isn't enabled. Use the Get-IRMConfiguration cmdlet to check the InternalLicensingEnabled parameter. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RMSTemplate - - Identity - - The Identity parameter specifies the name of the RMS template. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - RmsTrustedPublishingDomainIdParameter - - RmsTrustedPublishingDomainIdParameter - - - None - - - 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 - - RmsTemplateType - - RmsTemplateType - - - None - - - - - - Identity - - The Identity parameter specifies the name of the RMS template. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - RmsTrustedPublishingDomainIdParameter - - RmsTrustedPublishingDomainIdParameter - - - None - - - 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 - - RmsTemplateType - - RmsTemplateType - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-rmstemplate - - - - - - New-JournalRule - New - JournalRule - - This cmdlet is available in 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-JournalRule cmdlet to create a journal rule in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The New-JournalRule cmdlet creates a journal rule in your organization. - By default, new journal rules are disabled unless the Enabled parameter is set to $true. For more information about how to enable a new journal rule that was created in a disabled state, see Enable-JournalRule (https://docs.microsoft.com/powershell/module/exchange/enable-journalrule). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-JournalRule - - Name - - The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters long. - - String - - String - - - None - - - JournalEmailAddress - - The JournalEmailAddress parameter specifies a recipient object to which journal reports are sent. You ean use any value that uniquely identifies the recipient. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - Scope - - 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. - - JournalRuleScope - - JournalRuleScope - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters long. - - String - - String - - - None - - - JournalEmailAddress - - The JournalEmailAddress parameter specifies a recipient object to which journal reports are sent. You ean use any value that uniquely identifies the recipient. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enabled - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - Scope - - 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. - - JournalRuleScope - - JournalRuleScope - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-JournalRule -Name "Brokerage Communications" -JournalEmailAddress "Brokers Journal Mailbox" -Scope Global -Recipient brokers@contoso.com -Enabled $true - - This example creates and enables a journal rule. The rule applies to all email messages that pass through the Transport service and contain at least one recipient or sender who is a member of the brokers@contoso.com distribution list. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-journalrule - - - - - - New-OrganizationSegment - New - OrganizationSegment - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-OrganizationSegment cmdlet to create organization segments for use with information barrier policies in the Security & Compliance Center. Organization Segments are not in effect until you apply information barrier policies (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#part-3-apply-information-barrier-policies). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For more information about the filterable attributes that you can use to define segments, see Attributes for information barrier policies (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-OrganizationSegment - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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). - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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). - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-organizationsegment - - - Attributes for information barrier policies - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - - - - Remove-JournalRule - Remove - JournalRule - - This cmdlet is available in 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-JournalRule cmdlet to remove an existing journal rule. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Remove-JournalRule cmdlet removes the specified journal rule from Active Directory. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-JournalRule - - Identity - - The Identity parameter specifies the rule you want to remove. Enter either name or the GUID of the journal rule. You can omit the parameter label. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the rule you want to remove. Enter either name or the GUID of the journal rule. You can omit the parameter label. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-JournalRule "Brokerage Communications" - - This example removes the journal rule Brokerage Communications that's no longer needed. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-journalrule - - - - - - Remove-OrganizationSegment - Remove - OrganizationSegment - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-OrganizationSegment cmdlet to remove organization segments from the Security & Compliance Center.. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-OrganizationSegment - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-OrganizationSegment -Identity "Engineering Group" - - This example removes the organization segment named Engineering Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-organizationsegment - - - Attributes for information barrier policies - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - New-InformationBarrierPolicy - https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy - - - - - - Set-IRMConfiguration - Set - IRMConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - IRM requires the use of an on-premises AD RMS server or the ILS service. IRM features can be selectively enabled or disabled. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-IRMConfiguration - - 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". - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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. This is the default value. - - $false: Prevents new Azure Information Protection features from automatically being introduced into your tenant organization. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - This parameter replaces the deprecated DecryptAttachmentFromPortal parameter. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). - - Boolean - - Boolean - - - None - - - EnablePdfEncryption - - This parameter is available only in the cloud-based service. - The EnablePdfEncryption parameter specifies whether to enable the encryption of PDF attachments using Office 365 Message Encryption (OME). Valid values are: - - $true: Messages that contain PDF attachments can be encrypted. - - $false: Messages that contain PDF attachments can't be encrypted. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - JournalReportDecryptionEnabled - - The JournalReportDecryptionEnabled parameter specifies whether to enable journal report decryption. Valid values are: - - $true: Journal report encryption is enabled. A decrypted copy of the IRM-protected message is attached to the journal report. This is the default value. Note that journal report decryption requires additional configuration on AD RMS servers. For more information, see Journal report decryption (https://docs.microsoft.com/exchange/journal-report-decryption-exchange-2013-help). - $false: Journal report decryption is disabled. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - TransportDecryptionSetting - - TransportDecryptionSetting - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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". - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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. This is the default value. - - $false: Prevents new Azure Information Protection features from automatically being introduced into your tenant organization. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - This parameter replaces the deprecated DecryptAttachmentFromPortal parameter. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). - - Boolean - - Boolean - - - None - - - EnablePdfEncryption - - This parameter is available only in the cloud-based service. - The EnablePdfEncryption parameter specifies whether to enable the encryption of PDF attachments using Office 365 Message Encryption (OME). Valid values are: - - $true: Messages that contain PDF attachments can be encrypted. - - $false: Messages that contain PDF attachments can't be encrypted. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - JournalReportDecryptionEnabled - - The JournalReportDecryptionEnabled parameter specifies whether to enable journal report decryption. Valid values are: - - $true: Journal report encryption is enabled. A decrypted copy of the IRM-protected message is attached to the journal report. This is the default value. Note that journal report decryption requires additional configuration on AD RMS servers. For more information, see Journal report decryption (https://docs.microsoft.com/exchange/journal-report-decryption-exchange-2013-help). - $false: Journal report decryption is disabled. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Uri - - Uri - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - TransportDecryptionSetting - - TransportDecryptionSetting - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-irmconfiguration - - - - - - Set-JournalRule - Set - JournalRule - - This cmdlet is available in 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-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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Set-JournalRule cmdlet modifies an existing journal rule used in your organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-JournalRule - - Identity - - The Identity parameter specifies the name or GUID of the rule you want to modify. - The Identity parameter is a positional parameter. When using positional parameters in a command, you can omit the parameter label. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - JournalEmailAddress - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Name - - The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters. - - String - - String - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - Scope - - 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. - - JournalRuleScope - - JournalRuleScope - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the name or GUID of the rule you want to modify. - The Identity parameter is a positional parameter. When using positional parameters in a command, you can omit the parameter label. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - JournalEmailAddress - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - Name - - The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters. - - String - - String - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - Scope - - 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. - - JournalRuleScope - - JournalRuleScope - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Get-JournalRule | Set-JournalRule -JournalEmailAddress "Archive Mailbox" - - This example modifies the journal email address for all journal rules. The Get-JournalRule cmdlet is used to retrieve all journal rules. The results are piped to the Set-JournalRule cmdlet to modify the journal recipient. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-journalrule - - - - - - Set-OrganizationSegment - Set - OrganizationSegment - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-OrganizationSegment cmdlet to modify organization segments in the Security & Compliance Center. Organization Segments are not in effect until you apply information barrier policies (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#part-3-apply-information-barrier-policies). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Segments are defined by using certain attributes (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes)in Azure Active Directory. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-OrganizationSegment - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - 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). - - String - - String - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$true`, `$false`, or `$null`). - 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). - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-organizationsegment - - - Attributes for information barrier policies - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - New-InformationBarrierPolicy - https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy - - - - - - Test-IRMConfiguration - Test - IRMConfiguration - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-IRMConfiguration - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Test-IRMConfiguration -Sender adams@contoso.com - - This example tests the IRM configuration for messages sent from the sender adams@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-irmconfiguration - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.TransportMailflow-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.TransportMailflow-Help.xml deleted file mode 100644 index e2530b901525..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.TransportMailflow-Help.xml +++ /dev/null @@ -1,102658 +0,0 @@ - - - - - Disable-AntiPhishRule - Disable - AntiPhishRule - - This cmdlet is available only in the cloud-based service. - Use the Disable-AntiPhishRule cmdlet to disable antiphish rules in your cloud-based organization.. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-AntiPhishRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-AntiPhishRule -Identity "Engineering Department Phishing Rule" - - This example disables the antiphish rule named Engineering Department Phishing Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-antiphishrule - - - - - - Disable-HostedContentFilterRule - Disable - HostedContentFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-HostedContentFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-HostedContentFilterRule "Contoso Recipients" - - This example disables the enabled spam filter rule named Contoso Recipients. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-hostedcontentfilterrule - - - - - - Disable-HostedOutboundSpamFilterRule - Disable - HostedOutboundSpamFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-HostedOutboundSpamFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-HostedOutboundSpamFilterRule "Contoso Executives" - - This example disables the enabled outbound spam filter rule named Contoso Executives. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-hostedoutboundspamfilterrule - - - - - - Disable-InboxRule - Disable - InboxRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-InboxRule - - 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`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - - SwitchParameter - - - False - - - - - - 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`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work on this cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-InboxRule -Identity "MoveAnnouncements" -Mailbox "Joe@Contoso.com" - - This example disables the Inbox rule MoveAnnouncements in the mailbox Joe@Contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-inboxrule - - - - - - Disable-MalwareFilterRule - Disable - MalwareFilterRule - - This cmdlet is available in 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-MalwareFilterRule cmdlet to disable malware filter rules in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-MalwareFilterRule - - Identity - - The Identity parameter specifies the malware filter rule that you want to disable. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the malware filter rule that you want to disable. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-MalwareFilterRule "Contoso Recipients" - - This example disables the enabled malware filter rule named Contoso Recipients. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-malwarefilterrule - - - - - - Disable-SafeAttachmentRule - Disable - SafeAttachmentRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-SafeAttachmentRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-SafeAttachmentRule -Identity "Engineering Department Attachment Rule" - - This example disables the safe attachment rule named Engineering Department Attachment Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-safeattachmentrule - - - - - - Disable-SafeLinksRule - Disable - SafeLinksRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-SafeLinksRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-SafeLinksRule -Identity "Engineering Department URL Rule" - - This example disables the enabled Safe Links rule named Engineering Department URL Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-safelinksrule - - - - - - Disable-SweepRule - Disable - SweepRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-SweepRule - - 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==`). - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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==`). - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-sweeprule - - - - - - Disable-TransportRule - Disable - TransportRule - - This cmdlet is available in 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-TransportRule cmdlet to disable transport rules (mail flow rules) in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - To enable rules that are disabled, use the Enable-TransportRule cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-TransportRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-TransportRule -Identity "Sales Disclaimer" - - This example disables the rule named Sales Disclaimer. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-transportrule - - - - - - Enable-AntiPhishRule - Enable - AntiPhishRule - - This cmdlet is available only in the cloud-based service. - Use the Enable-AntiPhishRule cmdlet to enable antiphish rules in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-AntiPhishRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-AntiPhishRule -Identity "Marketing Department Phishing Rule" - - This example enables the antiphish rule named Marketing Department Phishing Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-antiphishrule - - - - - - Enable-ComplianceTagStorage - Enable - ComplianceTagStorage - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Enable-ComplianceTagStorage - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-ComplianceTagStorage - - This example creates the label policy in the Security & Compliance Center. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-compliancetagstorage - - - - - - Enable-HostedContentFilterRule - Enable - HostedContentFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-HostedContentFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-HostedContentFilterRule "Contoso Recipients" - - This example enables the disabled spam filter rule named Contoso Recipients. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-hostedcontentfilterrule - - - - - - Enable-HostedOutboundSpamFilterRule - Enable - HostedOutboundSpamFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-HostedOutboundSpamFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-HostedOutboundSpamFilterRule "Contoso Executives" - - This example enables the disabled outbound spam filter rule named Contoso Executives. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-hostedoutboundspamfilterrule - - - - - - Enable-InboxRule - Enable - InboxRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-InboxRule - - 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`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - AlwaysDeleteOutlookRulesBlob - - The AlwaysDeleteOutlookRulesBlob switch hides a warning message when end users or administrators use Outlook on the web or PowerShell to modify Inbox rules. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - AlwaysDeleteOutlookRulesBlob - - The AlwaysDeleteOutlookRulesBlob switch hides a warning message when end users or administrators use Outlook on the web or PowerShell to modify Inbox rules. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-inboxrule - - - - - - Enable-MalwareFilterRule - Enable - MalwareFilterRule - - This cmdlet is available in 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 enable malware filter rules in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-MalwareFilterRule - - Identity - - The Identity parameter specifies the malware filter rule that you want to enable. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the malware filter rule that you want to enable. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-MalwareFilterRule "Contoso Recipients" - - This example enables the disabled malware filter rule named Contoso Recipients. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-malwarefilterrule - - - - - - Enable-SafeAttachmentRule - Enable - SafeAttachmentRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-SafeAttachmentRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-SafeAttachmentRule -Identity "Marketing Department Attachment Rule" - - This example enables the disabled safe attachment rule named Marketing Department Attachment Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-safeattachmentrule - - - - - - Enable-SafeLinksRule - Enable - SafeLinksRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-SafeLinksRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-SafeLinksRule -Identity "Marketing Department URL Rule" - - This example enables the disabled Safe Links rule named Marketing Department URL Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-safelinksrule - - - - - - Enable-SweepRule - Enable - SweepRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-SweepRule - - 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==`). - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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==`). - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-sweeprule - - - - - - Enable-TransportRule - Enable - TransportRule - - This cmdlet is available in 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-TransportRule cmdlet to enable transport rules (mail flow rules) in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - To disable rules that are enabled, use the Disable-TransportRule cmdlet. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-TransportRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - RuleMode - - RuleMode - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - RuleMode - - RuleMode - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-TransportRule -Identity "Disclaimer-Finance" - - This example enables the transport rule named Disclaimer Finance. - - - - -------------------------- Example 2 -------------------------- - Enable-TransportRule -Identity "Require approval of messages to contoso.com" -Mode Audit - - This example enables the transport rule named "Require approval of messages to contoso.com" in audit mode, so you can see how the rule would function by analyzing the related entries in the message tracking log. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-transportrule - - - - - - Execute-AzureADLabelSync - Execute - AzureADLabelSync - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Execute-AzureADLabelSync cmdlet to start the synchronization of sensitivity labels into Azure Active Directory. This allows the application of sensitivity labels to Microsoft Teams sites, Microsoft 365 Groups, and SharePoint sites. This cmdlet is required if you were using sensitivity labels before September 2019. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Execute-AzureADLabelSync - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Execute-AzureADLabelSync - - This example will initialize the synchronization of sensitivity labels into Azure Active Directory. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/execute-azureadlabelsync - - - - - - Export-DlpPolicyCollection - Export - DlpPolicyCollection - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Export-DlpPolicyCollection cmdlet exports the settings of the DLP policies and the associated transport rules. You use the Import-DlpPolicyCollection to import the DLP policy collection into your organization. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Export-DlpPolicyCollection - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/export-dlppolicycollection - - - - - - Export-TransportRuleCollection - Export - TransportRuleCollection - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Export-TransportRuleCollection cmdlet can be used to export the transport rule collection in your organization. The format of the exported transport rule collection changed in Exchange Server 2013. The new format can't be imported into Exchange Server 2010. - Exporting the rules collection is a two-step process. You first export the rules collection to a variable, and then use the Set-Content cmdlet to write the data to an XML file. For more information, see Set-Content (https://docs.microsoft.com/powershell/module/microsoft.powershell.management/set-content). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Export-TransportRuleCollection - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 - - RuleCollectionFormat - - RuleCollectionFormat - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 - - RuleCollectionFormat - - RuleCollectionFormat - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - $file = Export-TransportRuleCollection -Set-Content -Path "C:\My Docs\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:\My Docs folder. Note : In PowerShell 6.0 or later, replace `-Encoding Byte` with `-AsByteStream`. - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/export-transportrulecollection - - - - - - Get-ActivityAlert - Get - ActivityAlert - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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 Microsoft 365. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ActivityAlert - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-activityalert - - - - - - Get-AntiPhishPolicy - Get - AntiPhishPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AntiPhishPolicy - - 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 - - AntiPhishPolicyIdParameter - - AntiPhishPolicyIdParameter - - - None - - - 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 only available in anti-phishing policies in Microsoft Defender for Office 365. - - - SwitchParameter - - - 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 only available in anti-phishing policies in Microsoft Defender for Office 365. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - - - 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 - - AntiPhishPolicyIdParameter - - AntiPhishPolicyIdParameter - - - None - - - 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 only available in anti-phishing policies in Microsoft Defender for Office 365. - - SwitchParameter - - SwitchParameter - - - 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 only available in anti-phishing policies in Microsoft Defender for Office 365. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AntiPhishPolicy | Format-Table Name,Enabled,IsDefault - - This example shows a summary list of all antiphish policies. - - - - -------------------------- Example 2 -------------------------- - Get-AntiPhishPolicy -Identity "Office365 AntiPhish Default" - - This example shows detailed information about the antiphish policy named Office 365 AntiPhish Default. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-antiphishpolicy - - - - - - Get-AntiPhishRule - Get - AntiPhishRule - - This cmdlet is available only in the cloud-based service. - Use the Get-AntiPhishRule cmdlet to view antiphish rules in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AntiPhishRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - State - - The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. - - RuleState - - RuleState - - - None - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - State - - The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. - - RuleState - - RuleState - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AntiPhishRule | Format-Table Name,Priority,State - - This example returns a summary list of all antiphish rules in your organization. - - - - -------------------------- Example 2 -------------------------- - Get-AntiPhishRule -Identity "Research Department Phishing Rule" - - This example returns detailed information about the antiphish rule named Research Department Phishing Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-antiphishrule - - - - - - Get-AtpPolicyForO365 - Get - AtpPolicyForO365 - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see Safe Links settings for Office 365 apps (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#safe-links-settings-for-office-365-apps). - Safe Documents scans documents and files that are opened in Protected View. For more information, see Safe Documents in Microsoft 365 E5 (https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-docs). - Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see Safe Attachments for SharePoint, OneDrive, and Microsoft Teams (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-AtpPolicyForO365 - - Identity - - The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. - - AtpPolicyForO365IdParameter - - AtpPolicyForO365IdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. - - AtpPolicyForO365IdParameter - - AtpPolicyForO365IdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AtpPolicyForO365 - - This example returns detailed information about the default policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-atppolicyforo365 - - - - - - Get-AuditConfig - Get - AuditConfig - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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 365. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-AuditConfig - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AuditConfig - - This example shows the auditing configuration in the Security & Compliance Center. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-auditconfig - - - - - - Get-AuditConfigurationPolicy - Get - AuditConfigurationPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-AuditConfigurationPolicy - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-auditconfigurationpolicy - - - - - - Get-AuditConfigurationRule - Get - AuditConfigurationRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-AuditConfigurationRule - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - - - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-auditconfigurationrule - - - - - - Get-AutoSensitivityLabelPolicy - Get - AutoSensitivityLabelPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-AutoSensitivityLabelPolicy cmdlet to view auto-labeling policies in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-AutoSensitivityLabelPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - DistributionDetail - - The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - DistributionDetail - - The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-autosensitivitylabelpolicy - - - - - - Get-AutoSensitivityLabelRule - Get - AutoSensitivityLabelRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-AutoSensitivityLabelPolicy cmdlet to view auto-labeling policy rules in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-AutoSensitivityLabelRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - Confirm - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - Confirm - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-AutoSensitivityLabelRule - - This example displays summary information for all autolabeling rules in the Security & Compliance Center. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-autosensitivitylabelrule - - - - - - Get-BlockedSenderAddress - Get - BlockedSenderAddress - - This cmdlet is available only in the cloud-based service. - Use the Get-BlockedSenderAddress cmdlet to view users in your Microsoft 365 organization that are impacted by the protection system. These users sent multiple messages that were classified as spam, so they're blocked from sending messages. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-BlockedSenderAddress - - SenderAddress - - The SenderAddress parameter filters the results by the email address of the blocked user. - - SmtpAddress - - SmtpAddress - - - None - - - - - - SenderAddress - - The SenderAddress parameter filters the results by the email address of the blocked user. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Exchange Management Shell cmdlet input and output types (https://docs.microsoft.com/exchange/client-developer/management/exchange-management-shell-cmdlet-input-and-output-types). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Exchange Management Shell cmdlet input and output types (https://docs.microsoft.com/exchange/client-developer/management/exchange-management-shell-cmdlet-input-and-output-types). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-BlockedSenderAddress - - This example returns information about all blocked senders. - - - - -------------------------- Example 2 -------------------------- - Get-BlockedSenderAddress -SenderAddress laura@contoso.com - - This example returns information about the blocked sender laura@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-blockedsenderaddress - - - - - - Get-CaseHoldPolicy - Get - CaseHoldPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-CaseHoldPolicy to view existing case hold policies in the Security & Compliance Center. 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-CaseHoldPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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 - - - SwitchParameter - - - False - - - IncludeBindings - - PARAMVALUE: SwitchParameter - - - SwitchParameter - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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 - - SwitchParameter - - SwitchParameter - - - False - - - IncludeBindings - - PARAMVALUE: SwitchParameter - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-caseholdpolicy - - - - - - Get-CaseHoldRule - Get - CaseHoldRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-CaseHoldRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-CaseHoldRule -Identity "30 Day Rule" - - This example displays detailed information for the case hold rule named "30 Day Rule". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-caseholdrule - - - - - - Get-ComplianceRetentionEvent - Get - ComplianceRetentionEvent - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ComplianceRetentionEvent - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ComplianceRetentionEvent | Format-Table Name,Description - - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEvent - - - - - - Get-ComplianceRetentionEventType - Get - ComplianceRetentionEventType - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ComplianceRetentionEventType - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEventType - - - - - - Get-ComplianceTag - Get - ComplianceTag - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-ComplianceTag cmdlet to view labels in the Security & Compliance Center. Labels apply retention settings to content. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ComplianceTag - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-compliancetag - - - - - - Get-ComplianceTagStorage - Get - ComplianceTagStorage - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ComplianceTagStorage - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-ComplianceTagStorage - - This example confirms that you've created the label policy in your organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-compliancetagstorage - - - - - - Get-DeviceConditionalAccessPolicy - Get - DeviceConditionalAccessPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DeviceConditionalAccessPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-deviceconditionalaccesspolicy - - - - - - Get-DeviceConditionalAccessRule - Get - DeviceConditionalAccessRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DeviceConditionalAccessRule - - 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}`. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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}`. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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}. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-deviceconditionalaccessrule - - - - - - Get-DeviceConfigurationPolicy - Get - DeviceConfigurationPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DeviceConfigurationPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-deviceconfigurationpolicy - - - - - - Get-DeviceConfigurationRule - Get - DeviceConfigurationRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DeviceConfigurationRule - - 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}`. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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}`. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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} - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-deviceconfigurationrule - - - - - - Get-DevicePolicy - Get - DevicePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DevicePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-devicepolicy - - - - - - Get-DeviceTenantPolicy - Get - DeviceTenantPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DeviceTenantPolicy - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-DeviceTenantPolicy - - This example shows information for your organization's mobile device tenant policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-devicetenantpolicy - - - - - - Get-DeviceTenantRule - Get - DeviceTenantRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DeviceTenantRule - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-DeviceTenantRule - - This example shows information for your organization's mobile device tenant rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-devicetenantrule - - - - - - Get-DkimSigningConfig - Get - DkimSigningConfig - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - DKIM in Microsoft 365 is an email authentication method that uses a public key infrastructure (PKI), message headers and CNAME records in DNS to authenticate the message sender, which is stamped in the DKIM-Signature header field. DKIM helps prevent forged sender email addresses (also known as spoofing) by verifying that the domain in the From address matches the domain in the DKIM-Signature header field. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DkimSigningConfig - - 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 - - DkimSigningConfigIdParameter - - DkimSigningConfigIdParameter - - - None - - - - - - 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 - - DkimSigningConfigIdParameter - - DkimSigningConfigIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dkimsigningconfig - - - - - - Get-DlpCompliancePolicy - Get - DlpCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DlpCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - DistributionDetail - - The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlpcompliancepolicy - - - - - - Get-DlpComplianceRule - Get - DlpComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DlpComplianceRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - IncludeExecutionRuleGuids - - {{ Fill IncludeExecutionRuleGuids Description }} - - $true | $false - - $true | $false - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - IncludeExecutionRuleGuids - - {{ Fill IncludeExecutionRuleGuids Description }} - - $true | $false - - $true | $false - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlpcompliancerule - - - - - - Get-DlpEdmSchema - Get - DlpEdmSchema - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-DlpEdmSchema cmdlet to view exact data match (EDM) data loss prevention (DLP) schemas in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DlpEdmSchema - - 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) - - EdmStorageIdParameter - - EdmStorageIdParameter - - - None - - - - - - 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) - - EdmStorageIdParameter - - EdmStorageIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-DlpEdmSchema - - This example returns a summary list of all DLP EDM schemas in the organization. - - - - -------------------------- Example 2 -------------------------- - Get-DlpEdmSchema -Identity "Schema for Patient Records" - - This example returns detailed information for the DLP EDM schema named Schema for patient Records. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Get-DlpEdmSchema - - - Create custom sensitive information types with Exact Data Match based classification - https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification - - - - - - Get-DlpKeywordDictionary - Get - DlpKeywordDictionary - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DlpKeywordDictionary - - 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. - - String - - String - - - None - - - - - - 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. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlpkeyworddictionary - - - - - - Get-DlpPolicy - Get - DlpPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DlpPolicy - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - - - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlppolicy - - - - - - Get-DlpPolicyTemplate - Get - DlpPolicyTemplate - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DlpPolicyTemplate - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - - - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlppolicytemplate - - - - - - Get-DlpSensitiveInformationType - Get - DlpSensitiveInformationType - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.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 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DlpSensitiveInformationType - - Identity - - The Identity parameter specifies the sensitive information type that you want to view. Valid values are: - - Name - - Id (GUID value) - - SensitiveInformationTypeIdParameter - - SensitiveInformationTypeIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the sensitive information type that you want to view. Valid values are: - - Name - - Id (GUID value) - - SensitiveInformationTypeIdParameter - - SensitiveInformationTypeIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype - - - - - - Get-DlpSensitiveInformationTypeRulePackage - Get - DlpSensitiveInformationTypeRulePackage - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-DlpSensitiveInformationTypeConfig cmdlet to view data loss prevention (DLP) sensitive information type rule packages in the Security & Compliance Center. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-DlpSensitiveInformationTypeRulePackage - - 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) - - SensitiveInformationTypeRuleCollectionIdParameter - - SensitiveInformationTypeRuleCollectionIdParameter - - - None - - - - - - 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) - - SensitiveInformationTypeRuleCollectionIdParameter - - SensitiveInformationTypeRuleCollectionIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtyperulepackage - - - - - - Get-HoldCompliancePolicy - Get - HoldCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-HoldCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - DistributionDetail - - The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-holdcompliancepolicy - - - - - - Get-HoldComplianceRule - Get - HoldComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-HoldComplianceRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-holdcompliancerule - - - - - - Get-HostedConnectionFilterPolicy - Get - HostedConnectionFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-HostedConnectionFilterPolicy - - 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. - - HostedConnectionFilterPolicyIdParameter - - HostedConnectionFilterPolicyIdParameter - - - None - - - - - - 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. - - HostedConnectionFilterPolicyIdParameter - - HostedConnectionFilterPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-HostedConnectionFilterPolicy | Format-List Name,IPBlockList,IPAllowList,EnableSafeList - - This example returns a summary list of all connection filter policies in your organization. - - - - -------------------------- Example 2 -------------------------- - Get-HostedConnectionFilterPolicy -Identity Default - - This example returns detailed information about the connection filter policy named Default. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-hostedconnectionfilterpolicy - - - - - - Get-HostedContentFilterPolicy - Get - HostedContentFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-HostedContentFilterPolicy - - 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 - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - - - - 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 - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-HostedContentFilterPolicy - - This example shows a summary list of all the spam filter policies in your cloud-based organization. - - - - -------------------------- Example 2 -------------------------- - Get-HostedContentFilterPolicy Default | Format-List - - This example retrieves details about the spam filter policy named Default. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-hostedcontentfilterpolicy - - - - - - Get-HostedContentFilterRule - Get - HostedContentFilterRule - - This cmdlet is available or 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-HostedContentFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - RuleState - - RuleState - - - None - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - RuleState - - RuleState - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-HostedContentFilterRule - - This example shows a summary list of all the spam filter rules in your cloud-based organization. - - - - -------------------------- Example 2 -------------------------- - Get-HostedContentFilterRule "Contoso Recipients" | Format-List - - This example retrieves details about the spam filter rule named Contoso Recipients. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-hostedcontentfilterrule - - - - - - Get-HostedOutboundSpamFilterPolicy - Get - HostedOutboundSpamFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-HostedOutboundSpamFilterPolicy - - 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 - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - - - - 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 - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-HostedOutboundSpamFilterPolicy | Format-Table Name,Enabled,IsDefault,Action* - - This example returns a summary list of all outbound spam filter policies. - - - - -------------------------- Example 2 -------------------------- - Get-HostedOutboundSpamFilterPolicy -Identity "Contoso Executives" - - This example returns detailed information about the outbound spam filter policy named Contoso Executives. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterpolicy - - - - - - Get-HostedOutboundSpamFilterRule - Get - HostedOutboundSpamFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-HostedOutboundSpamFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - RuleState - - RuleState - - - None - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - RuleState - - RuleState - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-HostedOutboundSpamFilterRule | Format-Table Name,Priority,State,HostedOutboundSpamFilterPolicy - - This example returns a summary list of all outbound spam filter rules. - - - - -------------------------- Example 2 -------------------------- - Get-HostedOutboundSpamFilterRule -Identity "Contoso Executives" - - This example returns detailed information for the outbound spam filter rule named "Contoso Executives" - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterrule - - - - - - Get-InboundConnector - Get - InboundConnector - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Inbound connectors accept email messages from remote domains that require specific configuration options. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-InboundConnector - - 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. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - - - - 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. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-inboundconnector - - - - - - Get-InboxRule - Get - InboxRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). Note : This cmdlet doesn't work for members of View-Only Organization Management role group in Exchange Online or the Global Reader role in Azure Active Directory. - - - - Get-InboxRule - - 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`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - IncludeHidden - - This parameter works 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. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - ExTimeZoneValue - - ExTimeZoneValue - - - None - - - 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`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - IncludeHidden - - This parameter works 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. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-inboxrule - - - - - - Get-InformationBarrierPoliciesApplicationStatus - Get - InformationBarrierPoliciesApplicationStatus - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-InformationBarrierPoliciesApplicationStatus cmdlet to view the application status of information barrier policies. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For more information, see View status of information barrier policy application (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#view-status-of-user-accounts-segments-policies-or-policy-application). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-InformationBarrierPoliciesApplicationStatus - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-InformationBarrierPoliciesApplicationStatus - - This example returns the most recent application of information barrier policies by the Start-InformationBarrierPoliciesApplication cmdlet. - - - - -------------------------- Example 2 -------------------------- - Get-InformationBarrierPoliciesApplicationStatus -All - - This example returns all applications of information barrier policies by the Start-InformationBarrierPoliciesApplication cmdlet. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - - - - Get-InformationBarrierPolicy - Get - InformationBarrierPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-InformationBarrierPolicy cmdlet to view information barrier policies in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For more information, see Information barrier policies (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-InformationBarrierPolicy - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - Guid - - Guid - - - None - - - - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - Guid - - Guid - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-InformationBarrierPolicy | Format-Table Name,State,AssignedSegment,Segments* -Auto - - This example displays a summary list of all information barrier policies. - - - - -------------------------- Example 2 -------------------------- - Get-InformationBarrierPolicy -Identity HR-Sales - - This example displays detailed information for the information barrier policy named HR-Sales. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierpolicy - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - New-InformationBarrierPolicy - https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy - - - - - - Get-InformationBarrierRecipientStatus - Get - InformationBarrierRecipientStatus - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-InformationBarrierRecipientStatus cmdlet to return information about recipients and their relationship to information barrier policies. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 <GUID>` 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. - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-InformationBarrierRecipientStatus - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - - - - 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 - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-InformationBarrierRecipientStatus -Identity meganb - - This example returns the information barrier policy information for the user meganb. - - - - -------------------------- Example 2 -------------------------- - Get-InformationBarrierRecipientStatus -Identity meganb -Identity2 alexw - - This example returns the information barrier policy relationship for the users meganb and alexw. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierrecipientstatus - - - Attributes for information barrier policies - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - New-InformationBarrierPolicy - https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy - - - - - - Get-Label - Get - Label - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-Label cmdlet to view sensitivity labels in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-Label - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-Label - - This example returns a summary list of all sensitivity labels in the organization. - - - - -------------------------- Example 2 -------------------------- - Get-Label -Identity "Engineering Group" | Format-List - - This example returns detailed information for the sensitivity label named Engineering Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-label - - - - - - Get-LabelPolicy - Get - LabelPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-LabelPolicy cmdlet to view sensitivity label policies in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-LabelPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-LabelPolicy | Format-Table Name - - This example returns a summary list of all policies in the organization. - - - - -------------------------- Example 2 -------------------------- - Get-LabelPolicy -Identity "Engineering Group" | Format-List - - This example returns detailed information for the policy named Engineering Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-labelpolicy - - - - - - Get-MalwareFilterPolicy - Get - MalwareFilterPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Malware filter policies contain the malware settings and a list of domains to which those settings apply. A domain can't belong to more than one malware filter policy. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MalwareFilterPolicy - - 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. - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - - - - 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. - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-malwarefilterpolicy - - - - - - Get-MalwareFilterRule - Get - MalwareFilterRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MalwareFilterRule - - 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. - - RuleIdParameter - - RuleIdParameter - - - None - - - State - - The State parameter filters the results by enabled or disabled malware filter rules. Valid input for this parameter is Enabled or Disabled. - - RuleState - - RuleState - - - None - - - - - - 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. - - RuleIdParameter - - RuleIdParameter - - - None - - - State - - The State parameter filters the results by enabled or disabled malware filter rules. Valid input for this parameter is Enabled or Disabled. - - RuleState - - RuleState - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-malwarefilterrule - - - - - - Get-MessageCategory - Get - MessageCategory - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-MessageCategory cmdlet is used by the web management interface in Microsoft Exchange to populate fields that display message category information. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MessageCategory - - Identity - - The Identity parameter specifies the name of the message category to be retrieved. - - MessageCategoryIdParameter - - MessageCategoryIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the name of the message category to be retrieved. - - MessageCategoryIdParameter - - MessageCategoryIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-MessageCategory -Mailbox "User1" - - This example retrieves message categories from the mailbox User1. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-messagecategory - - - - - - Get-OutboundConnector - Get - OutboundConnector - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Outbound connectors send email messages to remote domains that require specific configuration options. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OutboundConnector - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-OutboundConnector "Contoso Outbound Connector" | Format-List - - This example displays detailed information about the Outbound connector named Contoso Outbound Connector. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-outboundconnector - - - - - - Get-PerimeterConfig - Get - PerimeterConfig - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - - - - Get-PerimeterConfig - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - Identity - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-perimeterconfig - - - - - - Get-PolicyTipConfig - Get - PolicyTipConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PolicyTipConfig - - 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. - - PolicyTipMessageConfigAction - - PolicyTipMessageConfigAction - - - None - - - Locale - - The Locale parameter specifies a locale-specific version of the Policy Tip. - Valid values for this parameter are supported locale codes. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). - You can't use the Locale parameter with the Identity parameter. - - CultureInfo - - CultureInfo - - - None - - - 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. - - - SwitchParameter - - - False - - - - Get-PolicyTipConfig - - Identity - - The Identity parameter specifies the custom Policy Tip you want to view. You can use any value that uniquely identifies the custom Policy Tip. For example: - - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - - GUID - - Distinguished name (DN) - - You can't use the Identity parameter with the Action, Locale or Original parameters. - - PolicyTipConfigIdParameter - - PolicyTipConfigIdParameter - - - None - - - - - - 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. - - PolicyTipMessageConfigAction - - PolicyTipMessageConfigAction - - - None - - - Identity - - The Identity parameter specifies the custom Policy Tip you want to view. You can use any value that uniquely identifies the custom Policy Tip. For example: - - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - - GUID - - Distinguished name (DN) - - You can't use the Identity parameter with the Action, Locale or Original parameters. - - PolicyTipConfigIdParameter - - PolicyTipConfigIdParameter - - - None - - - Locale - - The Locale parameter specifies a locale-specific version of the Policy Tip. - Valid values for this parameter are supported locale codes. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). - You can't use the Locale parameter with the Identity parameter. - - CultureInfo - - CultureInfo - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-policytipconfig - - - - - - Get-ProtectionAlert - Get - ProtectionAlert - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-ProtectionAlert - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-protectionalert - - - - - - Get-RegulatoryComplianceUI - Get - RegulatoryComplianceUI - - This cmdlet is available only in the Security & Compliance Center. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-RegulatoryComplianceUI cmdlet to view the status of the regulatory compliance UI in the Security & Compliance Center (whether the preservation lock checkbox is displayed for retention policies and the immutable label checkbox is displayed for retention labels). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-RegulatoryComplianceUI - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-RegulatoryComplianceUI - - This example returns the status of regulatory compliance UI. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-regulatorycomplianceui - - - - - - Get-RetentionCompliancePolicy - Get - RetentionCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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). - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-RetentionCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ErrorPolicyOnly - - The ErrorPolicyOnly switch specifies whether to show only policies have distribution errors in the results. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy - - - - - - Get-RetentionComplianceRule - Get - RetentionComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-RetentionComplianceRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancerule - - - - - - Get-RetentionEvent - Get - RetentionEvent - - This cmdlet is available in 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-RetentionEvent - - Identity - - The Identity parameter specifies the retention event that you want to view. - - EwsStoreObjectIdParameter - - EwsStoreObjectIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Identity - - The Identity parameter specifies the retention event that you want to view. - - EwsStoreObjectIdParameter - - EwsStoreObjectIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-retentionevent - - - - - - Get-SafeAttachmentPolicy - Get - SafeAttachmentPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SafeAttachmentPolicy - - 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 - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - - - - 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 - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-SafeAttachmentPolicy - - This example shows a summary list of all safe attachment policies. - - - - -------------------------- Example 2 -------------------------- - Get-SafeAttachmentPolicy -Identity Default | Format-List - - This example shows detailed information about the safe attachment policy named Default. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-safeattachmentpolicy - - - - - - Get-SafeAttachmentRule - Get - SafeAttachmentRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SafeAttachmentRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - State - - The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. - - RuleState - - RuleState - - - None - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - State - - The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. - - RuleState - - RuleState - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-SafeAttachmentRule - - This example returns a summary list of all safe attachment rules in your organization. - - - - -------------------------- Example 2 -------------------------- - Get-SafeAttachmentRule -Identity "Research Department Attachment Rule" | Format-List - - This example returns detailed information about the safe attachment rule named Research Department Attachment Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-safeattachmentrule - - - - - - Get-SafeLinksPolicy - Get - SafeLinksPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SafeLinksPolicy - - 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 - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - - - - 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 - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-safelinkspolicy - - - - - - Get-SafeLinksRule - Get - SafeLinksRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SafeLinksRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - State - - The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. - - RuleState - - RuleState - - - None - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - State - - The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled. - - RuleState - - RuleState - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-safelinksrule - - - - - - Get-SupervisoryReviewActivity - Get - SupervisoryReviewActivity - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SupervisoryReviewActivity - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - PolicyId - - The PolicyId parameter specifies - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - PolicyId - - The PolicyId parameter specifies - - String - - String - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-SupervisoryReviewActivity -PolicyId $policyId -StartDate $startDate -EndDate $endDate | Sort-Object Timestamp -Descending | fl -PolicyId,ItemSubject,ActivityId,Timestamp,ActionType,ActionAppliedBy,ItemStatusAfterAction - - This example returns all the supervisory review activities for specified supervision policy. - - - - -------------------------- Example 2 -------------------------- - 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewactivity - - - - - - Get-SupervisoryReviewPolicyV2 - Get - SupervisoryReviewPolicyV2 - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-SupervisoryReviewPolicyV2 cmdlet to view supervisory review policies in the 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-SupervisoryReviewPolicyV2 - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyv2 - - - - - - Get-SupervisoryReviewRule - Get - SupervisoryReviewRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-SupervisoryReviewRule cmdlet to modify supervisory review rules in the 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-SupervisoryReviewRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewrule - - - - - - Get-SweepRule - Get - SweepRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SweepRule - - 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==`). - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Provider - - The Provider parameter filters the results by the specified provider. - - String - - String - - - None - - - - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Identity - - The Identity parameter specifies the Sweep rule that you want to view. You can use any value that uniquely identifies the rule. For example: - - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). - - Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). - - On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Provider - - The Provider parameter filters the results by the specified provider. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-sweeprule - - - - - - Get-TenantAllowBlockListItems - Get - TenantAllowBlockListItems - - Note : The features described in this topic are in Preview, are subject to change, and are not available in all organizations. - 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 Security & Compliance Center. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-TenantAllowBlockListItems - - ListType - - The ListType parameter specifies the list to view. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - Action - - The Action parameter filters the results by action type. Valid values are: - - Allow - - Block - - TenantAllowBlockList.ItemAction - - TenantAllowBlockList.ItemAction - - - None - - - Entry - - The Entry parameter filters the results by the specified URL or file hash value: - - The exact URL entry value. - - The exact SHA256 file hash value. - - String - - String - - - None - - - 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, `"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/2020 9:30 AM").ToUniversalTime()`. For more information, see Get-Date (https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - - SwitchParameter - - - False - - - - Get-TenantAllowBlockListItems - - ListType - - The ListType parameter specifies the list to view. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - Action - - The Action parameter filters the results by action type. Valid values are: - - Allow - - Block - - TenantAllowBlockList.ItemAction - - TenantAllowBlockList.ItemAction - - - None - - - Entry - - The Entry parameter filters the results by the specified URL or file hash value: - - The exact URL entry value. - - The exact SHA256 file hash value. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - - - ListType - - The ListType parameter specifies the list to view. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - Action - - The Action parameter filters the results by action type. Valid values are: - - Allow - - Block - - TenantAllowBlockList.ItemAction - - TenantAllowBlockList.ItemAction - - - None - - - Entry - - The Entry parameter filters the results by the specified URL or file hash value: - - The exact URL entry value. - - The exact SHA256 file hash value. - - String - - String - - - None - - - 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, `"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/2020 9:30 AM").ToUniversalTime()`. For more information, see Get-Date (https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TenantAllowBlockListItems -ListType Url -Action Block - - This example returns all blocked URLs. - - - - -------------------------- Example 2 -------------------------- - Get-TenantAllowBlockListItems -ListType FileHash -Entry "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08" - - This example returns information for the specified file hash value. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-tenantallowblocklistitems - - - - - - Get-TransportRule - Get - TransportRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - On Mailbox servers, this cmdlet returns all rules in the Exchange organization that are stored in Active Directory. On an Edge Transport server, this cmdlet only returns rules that are configured on the local server. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-TransportRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - RuleState - - RuleState - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - RuleState - - RuleState - - - None - - - 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. - - String - - String - - - None - - - 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://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-transportrule - - - - - - Get-TransportRuleAction - Get - TransportRuleAction - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In on-premises Exchange, the actions that are available on Mailboxes servers and Edge Transports server are different. Also, the names of some of the actions that are returned by this cmdlet are different than the corresponding parameter names in the New-TransportRule and Set-TransportRule cmdlets. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-TransportRuleAction - - 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. - - String - - String - - - None - - - - - - 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. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-transportruleaction - - - - - - Get-TransportRulePredicate - Get - TransportRulePredicate - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-TransportRulePredicate - - 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. - - String - - String - - - None - - - - - - 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. - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 About Pipelines (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - -------------------------- 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://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-transportrulepredicate - - - - - - Get-UnifiedAuditLogRetentionPolicy - Get - UnifiedAuditLogRetentionPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Get-UnifiedAuditLogRetentionPolicy cmdlet to view the properties of the audit log retention policies in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see Manage audit log retention policies (https://docs.microsoft.com/microsoft-365/compliance/audit-log-retention-policies). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Get-UnifiedAuditLogRetentionPolicy - - Operation - - The Operations parameter filters the results by the operations that are specified in the policy. For a list of the available values for this parameter, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String - - String - - - None - - - RecordType - - The RecordType parameter filters the results by the record types that are defined in the policy. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - - AuditLogRecordType - - AuditLogRecordType - - - None - - - RetentionDuration - - The RetentionDuration parameter filters the policy results by the retention duration specified in the policy. Valid values are: - - ThreeMonths - - SixMonths - - NineMonths - - TwelveMonths - - TenYears - - - ThreeMonths - SixMonths - NineMonths - TwelveMonths - TenYears - - UnifiedAuditLogRetentionDuration - - UnifiedAuditLogRetentionDuration - - - None - - - 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"`. - - String - - String - - - None - - - - - - Operation - - The Operations parameter filters the results by the operations that are specified in the policy. For a list of the available values for this parameter, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - String - - String - - - None - - - RecordType - - The RecordType parameter filters the results by the record types that are defined in the policy. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - - AuditLogRecordType - - AuditLogRecordType - - - None - - - RetentionDuration - - The RetentionDuration parameter filters the policy results by the retention duration specified in the policy. Valid values are: - - ThreeMonths - - SixMonths - - NineMonths - - TwelveMonths - - TenYears - - UnifiedAuditLogRetentionDuration - - UnifiedAuditLogRetentionDuration - - - None - - - 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"`. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-UnifiedAuditLogRetentionPolicy | Sort-Object -Property Priority -Descending | 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-unifiedauditlogretentionpolicy - - - - - - Import-DlpPolicyCollection - Import - DlpPolicyCollection - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Import-DlpPolicyCollection - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/import-dlppolicycollection - - - - - - Import-TransportRuleCollection - Import - TransportRuleCollection - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 (https://docs.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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Import-TransportRuleCollection - - 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, `(Get-Content -Encoding Byte -Path "C:\My Documents<filename>" -ReadCount 0)`. Note : In PowerShell 6.0 or later, replace `-Encoding Byte` with `-AsByteStream`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Force - - The Force switch specifies that the command will override any errors or warnings encountered during the import operation. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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, `(Get-Content -Encoding Byte -Path "C:\My Documents<filename>" -ReadCount 0)`. Note : In PowerShell 6.0 or later, replace `-Encoding Byte` with `-AsByteStream`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Force - - The Force switch specifies that the command will override any errors or warnings encountered during the import operation. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 named ExportedRules.xml in the C:\TransportRules folder. Note : In PowerShell 6.0 or later, replace `-Encoding Byte` with `-AsByteStream`. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/import-transportrulecollection - - - - - - Install-UnifiedCompliancePrerequisite - Install - UnifiedCompliancePrerequisite - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Install-UnifiedCompliancePrerequisite cmdlet to view, create, or configure the Compliance Policy Center in Microsoft SharePoint Online. The Compliance Policy Center is a site collection that's used by the 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet returns the following information about the Compliance Policy Center: - - SharepointRootSiteUrl: This value is typically `https://<domain>.sharepoint.com/`. - - SharepointTenantAdminUrl: This value uses the format `https://<domain>-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://<domain>.sharepoint.com/sites/compliancepolicycenter`. - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Install-UnifiedCompliancePrerequisite - - 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. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - Install-UnifiedCompliancePrerequisite - - 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. - - - SwitchParameter - - - False - - - - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/install-unifiedcomplianceprerequisite - - - - - - Invoke-HoldRemovalAction - Invoke - HoldRemovalAction - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the cmdlet to remove hold in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Invoke-HoldRemovalAction - - Action - - The Action parameter specifies if you want to get Hold information or remove hold. Supported values incude: - - GetHolds - - RemoveHold - - GetHoldRemovals - - Action - - HoldRemovalActionType - - - None - - - ExchangeLocation - - The ExchangeLocation specifies the mailbox location. - - - ExchangeLocation - - - False - - - HoldId - - The HoldId specifies which hold you want to remove. - - - HoldId - - - False - - - SharePointLocation - - The SharePointLocation specifies the sharepoint location to get hold information or remove hold. - - - SharePointLocation - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Invoke-HoldRemovalAction -Action RemoveHold -ExchangeLocation "KittyPetersen@contoso.onmicrosoft.com" -HoldId "UniHecbf89df-74fc-444a-a2dc-c0756c7d3503" - - This example removes hold "UniHecbf89df-74fc-444a-a2dc-c0756c7d3503" on "KittyPetersen@contoso.onmicrosoft.com": - - - - -------------------------- Example 2 -------------------------- - Invoke-HoldRemovalAction -Action GetHolds -SharePointLocation "https://contoso.sharepoint.com/sites/finance" - - This example displays all hold information on the sharepoint site. - - - - -------------------------- Example 3 -------------------------- - Invoke-HoldRemovalAction -Action GetHoldRemovals" - - This example displays all hold removals that have been done using this cmdlet. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange - - - - - - New-ActivityAlert - New - ActivityAlert - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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 Microsoft 365. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-ActivityAlert - - 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. - - Double - - Double - - - None - - - 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 ("). - - String - - String - - - None - - - NotifyUser - - The NotifyUser parameter specifies the email addressesfor notification messages. You can specify internal and external email addresses. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Operation - - The Operation parameter specifies the activity that triggers an activity alert. - A valid value for this parameter is an activity that's available in the Microsoft 365 audit log. For a description of these activities, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. - You can't use this parameter if the Type parameter value is ElevationOfPrivilege. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Type - - The Type parameter specifies the type alert. Valid values are: - - Custom: An alert is created for the activities you specify with the Operation parameter. Typically, you don't need to use this value (if you don't use the Type parameter, and you specify the activities with the Operations parameter, the value Custom is automatically added to the Type property). - - ElevationOfPrivilege: This value is being retired. - - SimpleAggregation: An alert is created based on the activities defined by the Operation and Condition parameters, the number of activities specified by the Threshold parameter, and the time period specified by the TimeWindow parameter. - - AnomalousAggregation: An alert is created based the activities defined by the Operation and Condition parameters, and the number of activities specified by the Multiplier parameter. Note : You can't change the Type value in an existing activity alert. - - AlertType - - AlertType - - - None - - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - Condition - - The Condition parameter specifies filter conditions for event aggregation. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - EmailCulture - - The EmailCulture parameter specifies the language of the notification email message. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - RecordType - - The RecordType parameter specifies a record type label for the activity alert. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - - AuditLogRecordType - - AuditLogRecordType - - - None - - - 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 - - AlertScopeLevel - - AlertScopeLevel - - - None - - - Severity - - The Severity parameter specifies a severity level for the activity alert. Valid values are: - - None - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - New-ActivityAlert - - 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 ("). - - String - - String - - - None - - - NotifyUser - - The NotifyUser parameter specifies the email addressesfor notification messages. You can specify internal and external email addresses. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Operation - - The Operation parameter specifies the activity that triggers an activity alert. - A valid value for this parameter is an activity that's available in the Microsoft 365 audit log. For a description of these activities, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. - You can't use this parameter if the Type parameter value is ElevationOfPrivilege. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Type - - The Type parameter specifies the type alert. Valid values are: - - Custom: An alert is created for the activities you specify with the Operation parameter. Typically, you don't need to use this value (if you don't use the Type parameter, and you specify the activities with the Operations parameter, the value Custom is automatically added to the Type property). - - ElevationOfPrivilege: This value is being retired. - - SimpleAggregation: An alert is created based on the activities defined by the Operation and Condition parameters, the number of activities specified by the Threshold parameter, and the time period specified by the TimeWindow parameter. - - AnomalousAggregation: An alert is created based the activities defined by the Operation and Condition parameters, and the number of activities specified by the Multiplier parameter. Note : You can't change the Type value in an existing activity alert. - - AlertType - - AlertType - - - None - - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - EmailCulture - - The EmailCulture parameter specifies the language of the notification email message. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - RecordType - - The RecordType parameter specifies a record type label for the activity alert. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - - AuditRecordType - - AuditLogRecordType - - - None - - - Severity - - The Severity parameter specifies a severity level for the activity alert. Valid values are: - - None - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - New-ActivityAlert - - 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 ("). - - String - - String - - - None - - - NotifyUser - - The NotifyUser parameter specifies the email addressesfor notification messages. You can specify internal and external email addresses. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Operation - - The Operation parameter specifies the activity that triggers an activity alert. - A valid value for this parameter is an activity that's available in the Microsoft 365 audit log. For a description of these activities, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. - You can't use this parameter if the Type parameter value is ElevationOfPrivilege. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Type - - The Type parameter specifies the type alert. Valid values are: - - Custom: An alert is created for the activities you specify with the Operation parameter. Typically, you don't need to use this value (if you don't use the Type parameter, and you specify the activities with the Operations parameter, the value Custom is automatically added to the Type property). - - ElevationOfPrivilege: This value is being retired. - - SimpleAggregation: An alert is created based on the activities defined by the Operation and Condition parameters, the number of activities specified by the Threshold parameter, and the time period specified by the TimeWindow parameter. - - AnomalousAggregation: An alert is created based the activities defined by the Operation and Condition parameters, and the number of activities specified by the Multiplier parameter. Note : You can't change the Type value in an existing activity alert. - - AlertType - - AlertType - - - None - - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - Condition - - The Condition parameter specifies filter conditions for event aggregation. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - EmailCulture - - The EmailCulture parameter specifies the language of the notification email message. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - RecordType - - The RecordType parameter specifies a record type label for the activity alert. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - - AuditLogRecordType - - AuditLogRecordType - - - None - - - 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 - - AlertScopeLevel - - AlertScopeLevel - - - None - - - Severity - - The Severity parameter specifies a severity level for the activity alert. Valid values are: - - None - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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 with the Type parameter value AnomalousAggregation. - - Double - - Double - - - None - - - 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 ("). - - String - - String - - - None - - - NotifyUser - - The NotifyUser parameter specifies the email addressesfor notification messages. You can specify internal and external email addresses. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Operation - - The Operation parameter specifies the activity that triggers an activity alert. - A valid value for this parameter is an activity that's available in the Microsoft 365 audit log. For a description of these activities, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. - You can't use this parameter if the Type parameter value is ElevationOfPrivilege. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Type - - The Type parameter specifies the type alert. Valid values are: - - Custom: An alert is created for the activities you specify with the Operation parameter. Typically, you don't need to use this value (if you don't use the Type parameter, and you specify the activities with the Operations parameter, the value Custom is automatically added to the Type property). - - ElevationOfPrivilege: This value is being retired. - - SimpleAggregation: An alert is created based on the activities defined by the Operation and Condition parameters, the number of activities specified by the Threshold parameter, and the time period specified by the TimeWindow parameter. - - AnomalousAggregation: An alert is created based the activities defined by the Operation and Condition parameters, and the number of activities specified by the Multiplier parameter. Note : You can't change the Type value in an existing activity alert. - - AlertType - - AlertType - - - None - - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - Condition - - The Condition parameter specifies filter conditions for event aggregation. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - EmailCulture - - The EmailCulture parameter specifies the language of the notification email message. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - RecordType - - The RecordType parameter specifies a record type label for the activity alert. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - - AuditLogRecordType - - AuditLogRecordType - - - None - - - 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 - - AlertScopeLevel - - AlertScopeLevel - - - None - - - Severity - - The Severity parameter specifies a severity level for the activity alert. Valid values are: - - None - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-ActivityAlert -Name "External Sharing Alert" -Operation sharinginvitationcreated -NotifyUser chrisda@contoso.com,michelle@contoso.com -UserId laura@contoso.com,julia@contoso.com -Description "Notification for external sharing events by laura@contoso.com and julia@contoso.com" - - This example creates a new activity alert named External Sharing Alert that has the following properties: - - Operation: sharinginvitationcreated. - - NotifyUser: chrisda@contoso.com and michelle@contoso.com. - - UserId: laura@contoso.com and julia@contoso.com. - - Description: Notification for external sharing events by laura@contoso.com and julia@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-activityalert - - - - - - New-AntiPhishPolicy - New - AntiPhishPolicy - - This cmdlet is available only in the cloud-based service. - Use the New-AntiPhishPolicy cmdlet to create antiphish policies in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-AntiPhishPolicy - - Name - - The Name parameter specifies a unique name for the antiphish policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - SpoofAuthenticationFailAction - - SpoofAuthenticationFailAction - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - EnableMailboxIntelligence - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence (artificial intelligence that determines user email patterns with their frequent contacts). Valid values are: - - $true: Mailbox intelligence is enabled. This is the default value. - - $false: Mailbox intelligence is disabled. - - Boolean - - Boolean - - - None - - - EnableMailboxIntelligenceProtection - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The EnableMailboxIntelligenceProtection specifies whether to enable or disable enhanced impersonation results based on each user's individual sender map. This intelligence allows Microsoft 365 to customize user impersonation detection and better handle false positives. Valid values are: - - $true: Enable intelligence based impersonation protection. - - $false: Don't enable intelligence based impersonation protection. This is the default value. - - Boolean - - Boolean - - - None - - - EnableOrganizationDomainsProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableSimilarDomainsSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableSimilarUsersSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - 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. You specify the spoofed senders to allow or block using the New-TenantAllowBlockListSpoofItems cmdlet. - - $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. - - Boolean - - Boolean - - - None - - - EnableTargetedDomainsProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableTargetedUserProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - 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. The via tag (chris@contoso.com <u>via</u> fabrikam.com) is added if the domain in the From address (the message sender that's displayed in email clients) is different from the domain in the DKIM signature or the MAIL FROM address. - - $false: A question mark is never applied to the sender's photo. The via tag is still added if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. - - 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. This action will prevent the via tag from appearing in messages from the sender when unauthenticated sender identification is disabled. For instructions, see Configure spoof intelligence in Microsoft 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). - If you own the sender's domain, configure email authentication for the domain. For more information, see Configure email authentication for domains you own (https://docs.microsoft.com/microsoft-365/security/office-365-security/email-validation-and-authentication#configure-email-authentication-for-domains-you-own). - - Boolean - - Boolean - - - True - - - EnableUnusualCharactersSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - ExcludedDomains - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExcludedSenders - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ImpersonationProtectionState - - This setting is part of impersonation protection and is only available 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 - - ImpersonationProtectionState - - ImpersonationProtectionState - - - None - - - MailboxIntelligenceProtectionAction - - This setting is part of impersonation protection and is only available 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. - - BccMessage: Add the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter to the Bcc field of the message. - - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. - - ImpersonationAction - - ImpersonationAction - - - None - - - MailboxIntelligenceProtectionActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - PhishThresholdLevel - - This setting is part of advanced settings and is only available 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. - - Int32 - - Int32 - - - None - - - PolicyTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - SimilarUsersSafetyTipsCustomText - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - TargetedDomainActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedDomainProtectionAction - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: - - NoAction: This is the default value. - - BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedDomainsToProtect - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUserActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUserProtectionAction - - This setting is part of impersonation protection and is only available 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. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUsersToProtect - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UnusualCharactersSafetyTipsCustomText - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the antiphish policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - SpoofAuthenticationFailAction - - SpoofAuthenticationFailAction - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - EnableMailboxIntelligence - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence (artificial intelligence that determines user email patterns with their frequent contacts). Valid values are: - - $true: Mailbox intelligence is enabled. This is the default value. - - $false: Mailbox intelligence is disabled. - - Boolean - - Boolean - - - None - - - EnableMailboxIntelligenceProtection - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The EnableMailboxIntelligenceProtection specifies whether to enable or disable enhanced impersonation results based on each user's individual sender map. This intelligence allows Microsoft 365 to customize user impersonation detection and better handle false positives. Valid values are: - - $true: Enable intelligence based impersonation protection. - - $false: Don't enable intelligence based impersonation protection. This is the default value. - - Boolean - - Boolean - - - None - - - EnableOrganizationDomainsProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableSimilarDomainsSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableSimilarUsersSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - 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. You specify the spoofed senders to allow or block using the New-TenantAllowBlockListSpoofItems cmdlet. - - $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. - - Boolean - - Boolean - - - None - - - EnableTargetedDomainsProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableTargetedUserProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - 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. The via tag (chris@contoso.com <u>via</u> fabrikam.com) is added if the domain in the From address (the message sender that's displayed in email clients) is different from the domain in the DKIM signature or the MAIL FROM address. - - $false: A question mark is never applied to the sender's photo. The via tag is still added if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. - - 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. This action will prevent the via tag from appearing in messages from the sender when unauthenticated sender identification is disabled. For instructions, see Configure spoof intelligence in Microsoft 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). - If you own the sender's domain, configure email authentication for the domain. For more information, see Configure email authentication for domains you own (https://docs.microsoft.com/microsoft-365/security/office-365-security/email-validation-and-authentication#configure-email-authentication-for-domains-you-own). - - Boolean - - Boolean - - - True - - - EnableUnusualCharactersSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - ExcludedDomains - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExcludedSenders - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ImpersonationProtectionState - - This setting is part of impersonation protection and is only available 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 - - ImpersonationProtectionState - - ImpersonationProtectionState - - - None - - - MailboxIntelligenceProtectionAction - - This setting is part of impersonation protection and is only available 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. - - BccMessage: Add the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter to the Bcc field of the message. - - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. - - ImpersonationAction - - ImpersonationAction - - - None - - - MailboxIntelligenceProtectionActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - PhishThresholdLevel - - This setting is part of advanced settings and is only available 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. - - Int32 - - Int32 - - - None - - - PolicyTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - SimilarUsersSafetyTipsCustomText - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - TargetedDomainActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedDomainProtectionAction - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: - - NoAction: This is the default value. - - BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedDomainsToProtect - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUserActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUserProtectionAction - - This setting is part of impersonation protection and is only available 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. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUsersToProtect - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UnusualCharactersSafetyTipsCustomText - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-antiphishpolicy - - - - - - New-AntiPhishRule - New - AntiPhishRule - - This cmdlet is available only in the cloud-based service. - Use the New-AntiPhishRule cmdlet to create antiphish rules in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-AntiPhishRule - - Name - - The Name parameter specifies a unique name for the antiphish rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the antiphish rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-antiphishrule - - - - - - New-AuditConfigurationPolicy - New - AuditConfigurationPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-AuditConfigurationPolicy - - Workload - - The Workload parameter specifies where auditing is allowed. Valid values are: - - Exchange - - OneDriveForBusiness - - SharePoint - - Workload - - Workload - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Workload - - The Workload parameter specifies where auditing is allowed. Valid values are: - - Exchange - - OneDriveForBusiness - - SharePoint - - Workload - - Workload - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-AuditConfigurationPolicy -Workload SharePoint - - This example creates an audit configuration policy for Microsoft SharePoint Online. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-auditconfigurationpolicy - - - - - - New-AuditConfigurationRule - New - AuditConfigurationRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-AuditConfigurationRule - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Workload - - The Workload parameter specifies where the audit configuration policy applies. Valid values are: - - Exchange - - OneDriveForBusiness - - SharePoint - - Workload - - Workload - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - AuditOperation - - The AuditOperation parameter specifies the operations that are audited by the rule. Valid values are: - - Administrate - - CheckIn - - CheckOut - - Count - - CreateUpdate - - Delete - - Forward - - MoveCopy - - PermissionChange - - ProfileChange - - SchemaChange - - Search - - SendAsOthers - - View - - Workflow - - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Workload - - The Workload parameter specifies where the audit configuration policy applies. Valid values are: - - Exchange - - OneDriveForBusiness - - SharePoint - - Workload - - Workload - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-AuditConfigurationRule -Workload SharePoint -AuditOperation Delete - - This example creates a new audit configuration rule for Microsoft SharePoint Online that audits delete operations. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-auditconfigurationrule - - - - - - New-AutoSensitivityLabelPolicy - New - AutoSensitivityLabelPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-AutoSensitivityLabelPolicy cmdlet to create auto-labeling policies in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-AutoSensitivityLabelPolicy - - Name - - The Name parameter specifies a unique name for the auto-labeling policy. If the value contains spaces, enclose the value with quotation marks ("). - - String - - String - - - None - - - ApplySensitivityLabel - - The ApplySensitivityLabel parameter specifies the label to use for the autolabel policy. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the policy is enabled. Valid values are: - - $true: The policy is enabled. - - $false: The policy is disabled. - - Boolean - - Boolean - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExchangeSender - - The ExchangeSender parameter specifies which senders to include in the policy. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderException - - The ExchangeSenderException parameter specifies which senders to exclude in the policy. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOf - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the auto-labeling policy. You identify the group by its email address. - You can enter multiple values separated by commas. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOfException - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the auto-labeling policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - - SwitchParameter - - - 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. - - - Enable - TestWithNotifications - TestWithoutNotifications - Disable - PendingDeletion - - PolicyMode - - PolicyMode - - - None - - - OneDriveLocation - - The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value. The value All is currently 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - SharePointLocation - - The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value. The value All is currently 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"`. SharePoint Online sites can't be added to a policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the auto-labeling policy. If the value contains spaces, enclose the value with quotation marks ("). - - String - - String - - - None - - - ApplySensitivityLabel - - The ApplySensitivityLabel parameter specifies the label to use for the autolabel policy. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the policy is enabled. Valid values are: - - $true: The policy is enabled. - - $false: The policy is disabled. - - Boolean - - Boolean - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExchangeSender - - The ExchangeSender parameter specifies which senders to include in the policy. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderException - - The ExchangeSenderException parameter specifies which senders to exclude in the policy. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOf - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the auto-labeling policy. You identify the group by its email address. - You can enter multiple values separated by commas. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOfException - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the auto-labeling policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - PolicyMode - - PolicyMode - - - None - - - OneDriveLocation - - The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value. The value All is currently 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - SharePointLocation - - The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value. The value All is currently 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"`. SharePoint Online sites can't be added to a policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 autolabel policy named GlobalPolicy for the specified SharePoint Online and OneDrive for Business locations with the label "Test". The new policy has a descriptive comment and will be in simulation mode on creation. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-autosensitivitylabelpolicy - - - - - - New-AutoSensitivityLabelRule - New - AutoSensitivityLabelRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-AutoSensitivityLabelPolicy cmdlet to create auto-labeling policy rules in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-AutoSensitivityLabelRule - - 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 ("). - - String - - String - - - None - - - Workload - - The Workload parameter specifies the workload. Valid values are: - - Exchange - - OneDriveForBusiness - - SharePoint - - - Exchange - SharePoint - OneDriveForBusiness - - Workload - - Workload - - - None - - - 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. - - - InOrganization - NotInOrganization - None - - AccessScope - - AccessScope - - - None - - - ActivationDate - - This parameter is reserved for internal Microsoft use. - - System.DateTime - - System.DateTime - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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"})`. - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DocumentIsPasswordProtected - - The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - InOrganization - NotInOrganization - None - - AccessScope - - AccessScope - - - None - - - 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"}). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentIsPasswordProtected - - The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExceptIfProcessingLimitExceeded - - The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule 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. - - Boolean - - Boolean - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSenderIPRanges - - The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExpiryDate - - This parameter is reserved for internal Microsoft use. - - System.DateTime - - System.DateTime - - - None - - - From - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - FromMemberOf - - This parameter is reserved for internal Microsoft use. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ImmutableId - - This parameter is reserved for internal Microsoft use. - - System.Guid - - System.Guid - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Priority - - This parameter is reserved for internal Microsoft use. - - System.Int32 - - System.Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - - Low - Medium - High - None - Informational - Information - - RuleSeverity - - RuleSeverity - - - None - - - RuleErrorAction - - The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - - Ignore - - RetryThenBlock - - Blank (the value $null): This is the default value. - - - Ignore - RetryThenBlock - - PolicyRuleErrorAction - - PolicyRuleErrorAction - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - Workload - - The Workload parameter specifies the workload. Valid values are: - - Exchange - - OneDriveForBusiness - - SharePoint - - Workload - - Workload - - - None - - - 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. - - AccessScope - - AccessScope - - - None - - - ActivationDate - - This parameter is reserved for internal Microsoft use. - - System.DateTime - - System.DateTime - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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"})`. - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DocumentIsPasswordProtected - - The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - AccessScope - - AccessScope - - - None - - - 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"}). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentIsPasswordProtected - - The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExceptIfProcessingLimitExceeded - - The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule 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. - - Boolean - - Boolean - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSenderIPRanges - - The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExpiryDate - - This parameter is reserved for internal Microsoft use. - - System.DateTime - - System.DateTime - - - None - - - From - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - FromMemberOf - - This parameter is reserved for internal Microsoft use. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ImmutableId - - This parameter is reserved for internal Microsoft use. - - System.Guid - - System.Guid - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Priority - - This parameter is reserved for internal Microsoft use. - - System.Int32 - - System.Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - PolicyRuleErrorAction - - PolicyRuleErrorAction - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-autosensitivitylabelrule - - - - - - New-CaseHoldPolicy - New - CaseHoldPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-CaseHoldPolicy - - Name - - The Name parameter specifies the unique name of the case hold policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - Azure AD ObjectId (You can use the Get-AzureADUser (https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SharePointLocation - - The SharePointLocation parameter specifies the SharePoint Online and OneDrive for Business 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Name - - The Name parameter specifies the unique name of the case hold policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - Azure AD ObjectId (You can use the Get-AzureADUser (https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SharePointLocation - - The SharePointLocation parameter specifies the SharePoint Online and OneDrive for Business 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-CaseHoldPolicy -Name "Regulation 123 Compliance" -Case "123 Compliance Case" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" - - This example creates a case hold policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint Online site for the eDiscovery case named "123 Compliance Case". - Remember, after you create the policy, you need to create a rule for the policy by using the New-CaseHoldRule cmdlet. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-caseholdpolicy - - - - - - New-CaseHoldRule - New - CaseHoldRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-CaseHoldRule - - Name - - The Name parameter specifies a unique name for the case hold rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the case hold rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-caseholdrule - - - - - - New-ComplianceRetentionEvent - New - ComplianceRetentionEvent - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-ComplianceRetentionEvent cmdlet to create compliance retention events in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-ComplianceRetentionEvent - - 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 ("). - - String - - String - - - None - - - AssetId - - The AssetId parameter specifies the Property:Value pair found in the properties of SharePoint or OneDrive for Business documents that's used for retention. For example: - - 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. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - EventTags - - The EventTags parameter specifies the GUID value of the labels tha are associated with the compliance retention event. Run the following command to see the available GUID values: `Get-ComplianceTag | Format-Table Name,GUID`. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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`. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - ExchangeAssetIdQuery - - The ExchangeAssetIdQuery parameter specifies the keywords that are used to scope Exchange content for the compliance retention event. For details, see Keyword queries and search conditions for Content Search (https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). - - String - - String - - - None - - - SharePointAssetIdQuery - - The SharePointAssetIdQuery parameter specifies one or more the Property:Value pairs that you've specified in the properties (also known as Columns) of SharePoint and OneDrive for Business documents to scope the compliance retention event. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - AssetId - - The AssetId parameter specifies the Property:Value pair found in the properties of SharePoint or OneDrive for Business documents that's used for retention. For example: - - 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. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - EventTags - - The EventTags parameter specifies the GUID value of the labels tha are associated with the compliance retention event. Run the following command to see the available GUID values: `Get-ComplianceTag | Format-Table Name,GUID`. - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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`. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - ExchangeAssetIdQuery - - The ExchangeAssetIdQuery parameter specifies the keywords that are used to scope Exchange content for the compliance retention event. For details, see Keyword queries and search conditions for Content Search (https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). - - String - - String - - - None - - - SharePointAssetIdQuery - - The SharePointAssetIdQuery parameter specifies one or more the Property:Value pairs that you've specified in the properties (also known as Columns) of SharePoint and OneDrive for Business documents to scope the compliance retention event. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEvent - - - - - - New-ComplianceRetentionEventType - New - ComplianceRetentionEventType - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-ComplianceRetentionEventType - - 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. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-ComplianceRetentionEventType -Name "Fabrikam Project" - - This example creates a new retention event type name Fabrikam Project - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEventType - - - - - - New-ComplianceTag - New - ComplianceTag - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-ComplianceTag - - Name - - The Name parameter specifies a unique name for the label. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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="ReferenceA"},@{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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - Notes - - The Notes parameter specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Regulatory - - {{ Fill Regulatory Description }} - - Boolean - - Boolean - - - None - - - RetentionAction - - The RetentionAction parameter specifies the action for the label. Valid values are: - - Delete - - Keep - - KeepAndDelete - - String - - String - - - None - - - RetentionDuration - - The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - - A positive integer. - - The value unlimited. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - 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. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the label. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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="ReferenceA"},@{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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - Notes - - The Notes parameter specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Regulatory - - {{ Fill Regulatory Description }} - - Boolean - - Boolean - - - None - - - RetentionAction - - The RetentionAction parameter specifies the action for the label. Valid values are: - - Delete - - Keep - - KeepAndDelete - - String - - String - - - None - - - RetentionDuration - - The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - - A positive integer. - - The value unlimited. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - 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. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-compliancetag - - - - - - New-DeviceConditionalAccessPolicy - New - DeviceConditionalAccessPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DeviceConditionalAccessPolicy - - Name - - The Name parameter specifies a unique name for the policy. If the value contains spaces, enclose the value in double quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the policy. If the value contains spaces, enclose the value in double quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-DeviceConditionalAccessPolicy -Identity "Human Resources" - - This example creates a new mobile device conditional access policy named Human Resources - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-deviceconditionalaccesspolicy - - - - - - New-DeviceConditionalAccessRule - New - DeviceConditionalAccessRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DeviceConditionalAccessRule - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - CARatingAppsEntry - - CARatingAppsEntry - - - None - - - 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. - - CAAutoUpdateStatusEntry - - CAAutoUpdateStatusEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Required - - Required - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - CARatingMovieEntry - - CARatingMovieEntry - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - CARatingRegionEntry - - CARatingRegionEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - CARatingTvShowEntry - - CARatingTvShowEntry - - - None - - - 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. - - CAUserAccountControlStatusEntry - - CAUserAccountControlStatusEntry - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - CARatingAppsEntry - - CARatingAppsEntry - - - None - - - 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. - - CAAutoUpdateStatusEntry - - CAAutoUpdateStatusEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Required - - Required - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - CARatingMovieEntry - - CARatingMovieEntry - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - CARatingRegionEntry - - CARatingRegionEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - CARatingTvShowEntry - - CARatingTvShowEntry - - - None - - - 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. - - CAUserAccountControlStatusEntry - - CAUserAccountControlStatusEntry - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-deviceconditionalaccessrule - - - - - - New-DeviceConfigurationPolicy - New - DeviceConfigurationPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DeviceConfigurationPolicy - - Name - - The Name parameter specifies a unique name for the policy. If the value contains spaces, enclose the value in double quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the policy. If the value contains spaces, enclose the value in double quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-DeviceConfigurationPolicy -Name "Engineering Group" - - This example creates a new mobile device configuration policy named Engineering Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-deviceconfigurationpolicy - - - - - - New-DeviceConfigurationRule - New - DeviceConfigurationRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DeviceConfigurationRule - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - RatingAppsEntry - - RatingAppsEntry - - - None - - - 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. - - AutoUpdateStatusEntry - - AutoUpdateStatusEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Required - - Required - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - RatingMovieEntry - - RatingMovieEntry - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - RatingRegionEntry - - RatingRegionEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - RatingTvShowEntry - - RatingTvShowEntry - - - None - - - 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. - - UserAccountControlStatusEntry - - UserAccountControlStatusEntry - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - RatingAppsEntry - - RatingAppsEntry - - - None - - - 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. - - AutoUpdateStatusEntry - - AutoUpdateStatusEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Required - - Required - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - RatingMovieEntry - - RatingMovieEntry - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - RatingRegionEntry - - RatingRegionEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - RatingTvShowEntry - - RatingTvShowEntry - - - None - - - 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. - - UserAccountControlStatusEntry - - UserAccountControlStatusEntry - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-deviceconfigurationrule - - - - - - New-DeviceTenantPolicy - New - DeviceTenantPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DeviceTenantPolicy - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-devicetenantpolicy - - - - - - New-DeviceTenantRule - New - DeviceTenantRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DeviceTenantRule - - ApplyPolicyTo - - The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - - ExchangeOnline - - SharePointOnline - - ExchangeAndSharePoint - - PolicyResourceScope - - PolicyResourceScope - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - ApplyPolicyTo - - The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - - ExchangeOnline - - SharePointOnline - - ExchangeAndSharePoint - - PolicyResourceScope - - PolicyResourceScope - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-devicetenantrule - - - - - - New-DkimSigningConfig - New - DkimSigningConfig - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - DKIM in Microsoft 365 is an email authentication method that uses a public key infrastructure (PKI), message headers, and CNAME records in DNS to authenticate the message sender, which is stamped in the DKIM-Signature header field. DKIM helps prevent forged sender email addresses (also known as spoofing) by verifying that the domain in the From address matches the domain in the DKIM-Signature header field. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-DkimSigningConfig - - DomainName - - The DomainName parameter specifies the domain in your organization that you want to enable DKIM message signing for. - By default, DKIM message signing is enabled for the initial *.onmicrosoft.com domain in the organization (for example, contoso.onmicrosoft.com). - For custom domains that don't have DKIM messaging signing enabled, the DKIM signatures for the *.onmicrosoft.com domain are added to messages. - - SmtpDomainWithSubdomains - - SmtpDomainWithSubdomains - - - None - - - 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. - - Boolean - - Boolean - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - BodyCanonicalization - - 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. - - CanonicalizationType - - CanonicalizationType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - HeaderCanonicalization - - 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. - - CanonicalizationType - - CanonicalizationType - - - None - - - KeySize - - The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are 1024 or 2048. - RSA keys are supported; Ed25519 keys aren't supported. - - UInt16 - - UInt16 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - DomainName - - The DomainName parameter specifies the domain in your organization that you want to enable DKIM message signing for. - By default, DKIM message signing is enabled for the initial *.onmicrosoft.com domain in the organization (for example, contoso.onmicrosoft.com). - For custom domains that don't have DKIM messaging signing enabled, the DKIM signatures for the *.onmicrosoft.com domain are added to messages. - - SmtpDomainWithSubdomains - - SmtpDomainWithSubdomains - - - None - - - 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. - - Boolean - - Boolean - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - BodyCanonicalization - - 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. - - CanonicalizationType - - CanonicalizationType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - HeaderCanonicalization - - 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. - - CanonicalizationType - - CanonicalizationType - - - None - - - KeySize - - The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are 1024 or 2048. - RSA keys are supported; Ed25519 keys aren't supported. - - UInt16 - - UInt16 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-DkimSigningConfig -DomainName contoso.com -Enabled $true - - This example enables DKIM message signing for the contoso.com domain. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dkimsigningconfig - - - - - - New-DlpCompliancePolicy - New - DlpCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DlpCompliancePolicy - - Name - - The Name parameter specifies the unique name of the DLP policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExchangeSenderMemberOf - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the DLP policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOfException - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the DLP policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - - SwitchParameter - - - 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. - - PolicyMode - - PolicyMode - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to a policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SharePointOnPremisesLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SharePointServerLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TeamsLocation - - The TeamsLocation parameter specifies the Teams accounts to include in the DLP policy. You identify the account by its name or email address, or you can use the value All to include all accounts. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TeamsLocationException - - The TeamsLocation parameter specifies the Teams accounts to exclude form the DLP policy when you use the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the unique name of the DLP policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExchangeSenderMemberOf - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the DLP policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOfException - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the DLP policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - PolicyMode - - PolicyMode - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to a policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SharePointOnPremisesLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SharePointServerLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TeamsLocation - - The TeamsLocation parameter specifies the Teams accounts to include in the DLP policy. You identify the account by its name or email address, or you can use the value All to include all accounts. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TeamsLocationException - - The TeamsLocation parameter specifies the Teams accounts to exclude form the DLP policy when you use the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dlpcompliancepolicy - - - - - - New-DlpComplianceRule - New - DlpComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Each new rule must contain one condition filter or test, and one associated action. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DlpComplianceRule - - Name - - The Name parameter specifies the unique name of the new DLP rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - AccessScope - - AccessScope - - - None - - - ActivationDate - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - 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: - - `@{<AddToRecipients | CopyTo | BlindCopyTo> = "emailaddress"}`. For example, `@{AddToRecipients = "laura@contoso.com"}` or `@{BlindCopyTo = "julia@contoso.com"}`. - - `@{AddManagerAsRecipientType = "<To | Cc | Bcc>"}`. For example, `@{AddManagerAsRecipientType = "Bcc"}`. - - You can use this action in DLP policies that are scoped only to Exchange. - - PswsHashtable - - PswsHashtable - - - None - - - 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 50. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 = <Append | Prepend>; FallbackAction = <Wrap | Ignore | Reject> }`. - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BlockAccessScope - - The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - - All: Block access to everyone except the owner and the last modifier. - - PerUser: Block access to external users. - - PerAnonymousUser: Block access to people through the "Anyone with the link" option in SharePoint and OneDrive. - - BlockAccessScope - - BlockAccessScope - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - ContentExtensionMatchesWords - - The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - DocumentIsPasswordProtected - - The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - $true | $false - - $true | $false - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - DocumentNameMatchesPatterns - - The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule 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"`. - The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DocumentNameMatchesWords - - The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the file 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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 inside the organization. - - NotInOrganization: The rule isn't applied to content that's accessible outside the organization. - - None: The exception isn't used. - - AccessScope - - AccessScope - - - None - - - 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 50. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. - Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see What the sensitive information types in Exchange look for (https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - ExceptIfContentExtensionMatchesWords - - The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentIsPasswordProtected - - The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - $true | $false - - $true | $false - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - ExceptIfDocumentNameMatchesPatterns - - The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule 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"`. - The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentNameMatchesWords - - The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the file 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - FromScope - - FromScope - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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: Encrypted messages. - - PermissionControlled: Messages that have specific permissions configured. - - ReadReceipt: Read receipts. - - Signed: Digitally signed messages. - - You can use this exception in DLP policies that are scoped only to Exchange. - - MessageTypes - - MessageTypes - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - WithImportance - - WithImportance - - - None - - - ExpiryDate - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - FromMemberOf - - This parameter is reserved for internal Microsoft use. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - FromScope - - The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: - - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - - 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. - - FromScope - - FromScope - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - ImmutableId - - This parameter is reserved for internal Microsoft use. - - Guid - - Guid - - - None - - - 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, if you use any of these redundant values with the value Default, they will be ignored. - - ReportContentOption[] - - ReportContentOption[] - - - None - - - 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: Encrypted messages. - - PermissionControlled: Messages that have specific permissions configured. - - ReadReceipt: Read receipts. - - Signed: Digitally signed messages. - - You can use this condition in DLP policies that are scoped only to Exchange. - - MessageTypes - - MessageTypes - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - OverrideOption[] - - OverrideOption[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - NotifyPolicyTipCustomTextTranslations - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - PrependSubject - - The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - PolicyRuleErrorAction - - PolicyRuleErrorAction - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - WithImportance - - WithImportance - - - None - - - - - - Name - - The Name parameter specifies the unique name of the new DLP rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - AccessScope - - AccessScope - - - None - - - ActivationDate - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - 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: - - `@{<AddToRecipients | CopyTo | BlindCopyTo> = "emailaddress"}`. For example, `@{AddToRecipients = "laura@contoso.com"}` or `@{BlindCopyTo = "julia@contoso.com"}`. - - `@{AddManagerAsRecipientType = "<To | Cc | Bcc>"}`. For example, `@{AddManagerAsRecipientType = "Bcc"}`. - - You can use this action in DLP policies that are scoped only to Exchange. - - PswsHashtable - - PswsHashtable - - - None - - - 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 50. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 = <Append | Prepend>; FallbackAction = <Wrap | Ignore | Reject> }`. - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BlockAccessScope - - The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - - All: Block access to everyone except the owner and the last modifier. - - PerUser: Block access to external users. - - PerAnonymousUser: Block access to people through the "Anyone with the link" option in SharePoint and OneDrive. - - BlockAccessScope - - BlockAccessScope - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - ContentExtensionMatchesWords - - The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - DocumentIsPasswordProtected - - The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - $true | $false - - $true | $false - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - DocumentNameMatchesPatterns - - The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule 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"`. - The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DocumentNameMatchesWords - - The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the file 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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 inside the organization. - - NotInOrganization: The rule isn't applied to content that's accessible outside the organization. - - None: The exception isn't used. - - AccessScope - - AccessScope - - - None - - - 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 50. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. - Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see What the sensitive information types in Exchange look for (https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - ExceptIfContentExtensionMatchesWords - - The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentIsPasswordProtected - - The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - $true | $false - - $true | $false - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - ExceptIfDocumentNameMatchesPatterns - - The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule 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"`. - The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentNameMatchesWords - - The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the file 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - FromScope - - FromScope - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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: Encrypted messages. - - PermissionControlled: Messages that have specific permissions configured. - - ReadReceipt: Read receipts. - - Signed: Digitally signed messages. - - You can use this exception in DLP policies that are scoped only to Exchange. - - MessageTypes - - MessageTypes - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - WithImportance - - WithImportance - - - None - - - ExpiryDate - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - FromMemberOf - - This parameter is reserved for internal Microsoft use. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - FromScope - - The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: - - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - - 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. - - FromScope - - FromScope - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - ImmutableId - - This parameter is reserved for internal Microsoft use. - - Guid - - Guid - - - None - - - 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, if you use any of these redundant values with the value Default, they will be ignored. - - ReportContentOption[] - - ReportContentOption[] - - - None - - - 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: Encrypted messages. - - PermissionControlled: Messages that have specific permissions configured. - - ReadReceipt: Read receipts. - - Signed: Digitally signed messages. - - You can use this condition in DLP policies that are scoped only to Exchange. - - MessageTypes - - MessageTypes - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - OverrideOption[] - - OverrideOption[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - NotifyPolicyTipCustomTextTranslations - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - PrependSubject - - The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - PolicyRuleErrorAction - - PolicyRuleErrorAction - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - 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. - - WithImportance - - WithImportance - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dlpcompliancerule - - - - - - New-DlpEdmSchema - New - DlpEdmSchema - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-DlpEdmSchema cmdlet to create exact data match (EDM)-based classification schemas in the Security & Compliance Center. Such schemas can be used with data loss prevention (DLP) policies. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For an explanation and example of the EDM schema, see Define the schema for your database of sensitive information (https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification#define-the-schema-for-your-database-of-sensitive-information). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DlpEdmSchema - - 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 Get-Content cmdlet. For example, `( Byte[] (Get-Content -Encoding Byte -Path "C:\My Documents\<filename>" -ReadCount 0))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 Get-Content cmdlet. For example, `( Byte[] (Get-Content -Encoding Byte -Path "C:\My Documents\<filename>" -ReadCount 0))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - $edmSchemaXml = Get-Content "C:\My Documents\edm.xml" -Encoding Byte -ReadCount 0 -New-DlpEdmSchema -FileData $edmSchemaXml -Confirm:$true - - This example creates a new DLP EDM schema. The first command reads the schema in the XML file to a variable, and the second command uses that information to create the DLP EDM schema. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dlpedmschema - - - - - - New-DlpFingerprint - New - DlpFingerprint - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.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 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DlpFingerprint - - 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. - - Byte[] - - Byte[] - - - None - - - Description - - The Description parameter specifies a description for the document fingerprint. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Description - - The Description parameter specifies a description for the document fingerprint. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Byte[] - - Byte[] - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dlpfingerprint - - - - - - New-DlpKeywordDictionary - New - DlpKeywordDictionary - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DlpKeywordDictionary - - Name - - The Name parameter specifies a unique name for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies descriptive text for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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. - - Byte[] - - Byte[] - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies descriptive text for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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. - - Byte[] - - Byte[] - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 = $Keywords | ForEach-Object{[System.Text.Encoding]::UTF8.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 -------------------------- - $Keywords = Get-Content "C:\My Documents\InappropriateTerms.txt" -$EncodedKeywords = $Keywords | ForEach-Object{[System.Text.Encoding]::UTF8.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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dlpkeyworddictionary - - - - - - New-DlpPolicy - New - DlpPolicy - - This cmdlet is available in 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-DlpPolicy cmdlet to create data loss prevention (DLP) policies in your Exchange organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-DlpPolicy - - Name - - The Name parameter specifies a descriptive name for the DLP policy. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the DLP policy. - - String - - String - - - None - - - Mode - - 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. - - RuleMode - - RuleMode - - - None - - - 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. - This parameter uses the syntax: `@{Parameter1="Value1";Parameter2="Value2"...}`. - - Hashtable - - Hashtable - - - None - - - State - - 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. - - RuleState - - RuleState - - - None - - - Template - - The Template parameter specifies the existing DLP policy template from which you can create a new DLP policy. You can't use the Template and TemplateData parameters in the same command. - - String - - String - - - None - - - 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\<filename>" -ReadCount 0))`. - - Byte[] - - Byte[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the DLP policy. - - String - - String - - - None - - - Mode - - 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. - - RuleMode - - RuleMode - - - None - - - Name - - The Name parameter specifies a descriptive name for the DLP policy. - - String - - String - - - None - - - 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. - This parameter uses the syntax: `@{Parameter1="Value1";Parameter2="Value2"...}`. - - Hashtable - - Hashtable - - - None - - - State - - 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. - - RuleState - - RuleState - - - None - - - Template - - The Template parameter specifies the existing DLP policy template from which you can create a new DLP policy. You can't use the Template and TemplateData parameters in the same command. - - String - - String - - - None - - - 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\<filename>" -ReadCount 0))`. - - Byte[] - - Byte[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dlppolicy - - - - - - New-DlpSensitiveInformationType - New - DlpSensitiveInformationType - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-DlpSensitiveInformationType cmdlet to create sensitive information type rules that use document fingerprints. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DlpSensitiveInformationType - - 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. - - String - - String - - - None - - - Description - - The Description parameter specifies a description for the sensitive information type rule. - - String - - String - - - None - - - Fingerprints - - The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see New-Fingerprint (https://docs.microsoft.com/powershell/module/exchange/new-fingerprint)or the Examples section. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SensitiveInformationTypeRuleCollectionIdentity - - This parameter is reserved for internal Microsoft use. - - ClassificationRuleCollectionIdParameter - - ClassificationRuleCollectionIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Locale - - The Locale parameter specifies the language that's associated with the sensitive information type rule. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - You can add additional language translations to the sensitive information type rule by using the Set-DlpSensitiveInformationType cmdlet. - - CultureInfo - - CultureInfo - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Description - - The Description parameter specifies a description for the sensitive information type rule. - - String - - String - - - None - - - Fingerprints - - The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see New-Fingerprint (https://docs.microsoft.com/powershell/module/exchange/new-fingerprint)or the Examples section. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - SensitiveInformationTypeRuleCollectionIdentity - - This parameter is reserved for internal Microsoft use. - - ClassificationRuleCollectionIdParameter - - ClassificationRuleCollectionIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Locale - - The Locale parameter specifies the language that's associated with the sensitive information type rule. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - You can add additional language translations to the sensitive information type rule by using the Set-DlpSensitiveInformationType cmdlet. - - CultureInfo - - CultureInfo - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype - - - - - - New-DlpSensitiveInformationTypeRulePackage - New - DlpSensitiveInformationTypeRulePackage - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-DlpSensitiveInformationTypeRulePackage - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/New-DlpSensitiveInformationTypeRulePackage - - - Create custom sensitive information types with Exact Data Match based classification - https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification - - - - - - New-HoldCompliancePolicy - New - HoldCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-HoldCompliancePolicy - - Name - - The Name parameter specifies the unique name of the preservation policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the unique name of the preservation policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-HoldCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" - - This example creates a preservation policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint Online site. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-holdcompliancepolicy - - - - - - New-HoldComplianceRule - New - HoldComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-HoldComplianceRule - - Name - - The Name parameter specifies a unique name for the preservation rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - Policy - - The Policy parameter specifies the policy to contain the rule. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - HoldDurationHint - - HoldDurationHint - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the preservation rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - Policy - - The Policy parameter specifies the policy to contain the rule. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - HoldDurationHint - - HoldDurationHint - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-holdcompliancerule - - - - - - New-HostedContentFilterPolicy - New - HostedContentFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - For more information about the limits for allowed and blocked senders, see Exchange Online Protection Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). - - - - New-HostedContentFilterPolicy - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - AllowedSenderDomains - - The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. Caution : Think very carefully before you add domains here. For more information, see Create safe sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedSenders - - The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. Caution : Think very carefully before you add senders here. For more information, see Create safe sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 9 (high confidence spam). Valid values are one or more SMTP domains. Note : Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see Create block sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. Note : Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see Create block sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - NoAction - - Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - BulkThreshold - - The BulkThreshold parameter specifies the BCL that triggers the BulkSpamAction on the message (greater than the specified value, not greater than or equal to). A valid value is an integer from 1 to 9, and the default value is 7. A higher value indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see Bulk compliant level (BCL) in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/bulk-complaint-level-values). - - Int32 - - Int32 - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DownloadLink - - The DownloadLink parameter shows or hides a link in end-user spam quarantine notifications to download the Junk Email Reporting Tool for Outlook. Valid values are: - - $true: end-user spam quarantine notifications contain a link to download the Junk Email Reporting Tool for Outlook. - - $false: end-user spam quarantine notifications don't contain the link. This is the default value. - - This parameter is only meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - Boolean - - Boolean - - - None - - - EnableEndUserSpamNotifications - - The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notifications. Valid values are: - - $true: End-users periodically receive notifications when a messages that was supposed to be delivered to them was quarantined as spam. When you use this value, you can also use the EndUserSpamNotificationCustomSubject, EndUserSpamNotificationFrequency, and EndUserSpamNotificationLanguage parameters. - - $false: end-user spam quarantine notifications are disabled. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EndUserSpamNotificationCustomFromAddress - - This parameter has been deprecated and is no longer used. - - SmtpAddress - - SmtpAddress - - - None - - - EndUserSpamNotificationCustomFromName - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - EndUserSpamNotificationCustomSubject - - The EndUserSpamNotificationCustomSubject parameter specifies a custom subject for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks ("). - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - String - - String - - - None - - - EndUserSpamNotificationFrequency - - The EndUserSpamNotificationFrequency parameter specifies the repeat interval in days that end-user spam quarantine notifications are sent. A valid value is an integer between 1 and 15. The default value is 3. - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - Int32 - - Int32 - - - None - - - EndUserSpamNotificationLanguage - - The EndUserSpamNotificationLanguage parameter specifies the language of end-user spam quarantine notifications. Valid values are: - Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. - The default value is Default, which means end-user spam quarantine notifications use the default language of the cloud-based organization. - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - EsnLanguage - - EsnLanguage - - - None - - - EndUserSpamNotificationLimit - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - HighConfidencePhishAction - - The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is only available to admins. - - PhishFilteringAction - - PhishFilteringAction - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - IncreaseScoreWithBizOrInfoUrls - - Note : This setting is part of Advanced Spam Filtering (ASF) and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links to .biz or .info domains are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithImageLinks - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain image links to remote websites are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithNumericIps - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links to IP addresses are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithRedirectToOtherPort - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - 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. - - Boolean - - Boolean - - - None - - - LanguageBlockList - - The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported ISO 639-1 two-letter language code: - af, ar, az, be, bg, bn, br, bs, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, fy, ga, gl, gu, ha, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kl, kn, ko, ku, ky, la, lb, lt, lv, mi, mk, ml, mn, mr, ms, mt, nb, nl, nn, pa, pl, ps, pt, rm, ro, ru, se, sk, sl, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, uz, vi, wen, yi, zh-cn, zh-tw, and zu. - A reference for two-letter language codes is available at ISO 639-2 (https://www.loc.gov/standards/iso639-2/php/code_list.php). Note that not all possible language codes are available as input for this parameter. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamEmbedTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML <embed> 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 <embed> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamEmptyMessages - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFormTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML <form> 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 <form> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFramesInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML <frame> or <iframe> 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 <frame> or <iframe> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFromAddressAuthFail - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamJavaScriptInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamNdrBackscatter - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as backscatter ). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamObjectTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML <object> 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 <object> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamSensitiveWordList - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamSpfRecordHardFail - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamWebBugsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - 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 ("). - - String - - String - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - 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. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the k Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - 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. - - Boolean - - Boolean - - - None - - - TestModeAction - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\ or MarkAsSpam\ ASF parameters are set to the value Test. Valid values are: - - None: This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringTestModeAction - - SpamFilteringTestModeAction - - - None - - - TestModeBccToRecipients - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. - Valid input for this parameter is an email address. Separate multiple email addresses with commas. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - AllowedSenderDomains - - The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. Caution : Think very carefully before you add domains here. For more information, see Create safe sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedSenders - - The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. Caution : Think very carefully before you add senders here. For more information, see Create safe sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 9 (high confidence spam). Valid values are one or more SMTP domains. Note : Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see Create block sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. Note : Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see Create block sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - NoAction - - Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - BulkThreshold - - The BulkThreshold parameter specifies the BCL that triggers the BulkSpamAction on the message (greater than the specified value, not greater than or equal to). A valid value is an integer from 1 to 9, and the default value is 7. A higher value indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see Bulk compliant level (BCL) in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/bulk-complaint-level-values). - - Int32 - - Int32 - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DownloadLink - - The DownloadLink parameter shows or hides a link in end-user spam quarantine notifications to download the Junk Email Reporting Tool for Outlook. Valid values are: - - $true: end-user spam quarantine notifications contain a link to download the Junk Email Reporting Tool for Outlook. - - $false: end-user spam quarantine notifications don't contain the link. This is the default value. - - This parameter is only meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - Boolean - - Boolean - - - None - - - EnableEndUserSpamNotifications - - The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notifications. Valid values are: - - $true: End-users periodically receive notifications when a messages that was supposed to be delivered to them was quarantined as spam. When you use this value, you can also use the EndUserSpamNotificationCustomSubject, EndUserSpamNotificationFrequency, and EndUserSpamNotificationLanguage parameters. - - $false: end-user spam quarantine notifications are disabled. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EndUserSpamNotificationCustomFromAddress - - This parameter has been deprecated and is no longer used. - - SmtpAddress - - SmtpAddress - - - None - - - EndUserSpamNotificationCustomFromName - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - EndUserSpamNotificationCustomSubject - - The EndUserSpamNotificationCustomSubject parameter specifies a custom subject for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks ("). - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - String - - String - - - None - - - EndUserSpamNotificationFrequency - - The EndUserSpamNotificationFrequency parameter specifies the repeat interval in days that end-user spam quarantine notifications are sent. A valid value is an integer between 1 and 15. The default value is 3. - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - Int32 - - Int32 - - - None - - - EndUserSpamNotificationLanguage - - The EndUserSpamNotificationLanguage parameter specifies the language of end-user spam quarantine notifications. Valid values are: - Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. - The default value is Default, which means end-user spam quarantine notifications use the default language of the cloud-based organization. - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - EsnLanguage - - EsnLanguage - - - None - - - EndUserSpamNotificationLimit - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - HighConfidencePhishAction - - The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is only available to admins. - - PhishFilteringAction - - PhishFilteringAction - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - IncreaseScoreWithBizOrInfoUrls - - Note : This setting is part of Advanced Spam Filtering (ASF) and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links to .biz or .info domains are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithImageLinks - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain image links to remote websites are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithNumericIps - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links to IP addresses are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithRedirectToOtherPort - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - 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. - - Boolean - - Boolean - - - None - - - LanguageBlockList - - The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported ISO 639-1 two-letter language code: - af, ar, az, be, bg, bn, br, bs, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, fy, ga, gl, gu, ha, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kl, kn, ko, ku, ky, la, lb, lt, lv, mi, mk, ml, mn, mr, ms, mt, nb, nl, nn, pa, pl, ps, pt, rm, ro, ru, se, sk, sl, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, uz, vi, wen, yi, zh-cn, zh-tw, and zu. - A reference for two-letter language codes is available at ISO 639-2 (https://www.loc.gov/standards/iso639-2/php/code_list.php). Note that not all possible language codes are available as input for this parameter. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamEmbedTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML <embed> 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 <embed> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamEmptyMessages - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFormTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML <form> 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 <form> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFramesInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML <frame> or <iframe> 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 <frame> or <iframe> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFromAddressAuthFail - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamJavaScriptInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamNdrBackscatter - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as backscatter ). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamObjectTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML <object> 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 <object> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamSensitiveWordList - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamSpfRecordHardFail - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamWebBugsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - 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 ("). - - String - - String - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - 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. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the k Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - 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. - - Boolean - - Boolean - - - None - - - TestModeAction - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\ or MarkAsSpam\ ASF parameters are set to the value Test. Valid values are: - - None: This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringTestModeAction - - SpamFilteringTestModeAction - - - None - - - TestModeBccToRecipients - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. - Valid input for this parameter is an email address. Separate multiple email addresses with commas. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-hostedcontentfilterpolicy - - - - - - New-HostedContentFilterRule - New - HostedContentFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-HostedContentFilterRule - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter enables or disables the rule. Valid input for this parameter is $true or $false. The default value is $true. - - Boolean - - Boolean - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - ExceptIfSentToMemberOf - - The ExceptIfSentToMemberOf parameter specifies an exception for the rule 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SentToMemberOf - - The SentToMemberOf parameter specifies a condition for the rule 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter enables or disables the rule. Valid input for this parameter is $true or $false. The default value is $true. - - Boolean - - Boolean - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - ExceptIfSentToMemberOf - - The ExceptIfSentToMemberOf parameter specifies an exception for the rule 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SentToMemberOf - - The SentToMemberOf parameter specifies a condition for the rule 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-hostedcontentfilterrule - - - - - - New-HostedOutboundSpamFilterPolicy - New - HostedOutboundSpamFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the HostedOutboundSpamFilterPolicy parameter on the New-HostedOutboundSpamFilterRule or Set-HostedOutboundSpamFilterRule cmdlets to associate the policy with a rule. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-HostedOutboundSpamFilterPolicy - - 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 ("). - - String - - String - - - None - - - 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. - - - Alert - BlockUserForToday - BlockUser - - OutboundRecipientLimitsExceededAction - - OutboundRecipientLimitsExceededAction - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AutoForwardingMode - - Note : Before September 2020, this setting is available but not enforced. - The AutoForwardingMode specifies how the policy controls automatic email forwarding to outbound recipients. Valid values are: - - Automatic: Automatic external email forwarding is blocked by the system. This is the default value. - - On: Automatic external email forwarding is not restricted. - - Off: Automatic external email forwarding is disabled and will result in a non-delivery report (also known as an NDR or bounce message) to the sender. - - This setting applies only to cloud-based mailboxes, and automatic forwarding to internal recipients is not affected by this setting. - - - Automatic - Off - On - - AutoForwardingMode - - AutoForwardingMode - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - NotifyOutboundSpam - - Note : This setting has been replaced by the default alert policy named User restricted from sending email , which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see Verify the alert settings for restricted users (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - 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. - - Boolean - - Boolean - - - None - - - NotifyOutboundSpamRecipients - - Note : This setting has been replaced by the default alert policy named User restricted from sending email , which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see Verify the alert settings for restricted users (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecipientLimitExternalPerHour - - The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see Sending limits across Microsoft 365 options (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - - UInt32 - - UInt32 - - - None - - - RecipientLimitInternalPerHour - - The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see Sending limits across Microsoft 365 options (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). - - UInt32 - - UInt32 - - - None - - - RecipientLimitPerDay - - The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see Sending limits across Microsoft 365 options (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). - - UInt32 - - UInt32 - - - None - - - - - - 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 ("). - - String - - String - - - None - - - 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. - - OutboundRecipientLimitsExceededAction - - OutboundRecipientLimitsExceededAction - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AutoForwardingMode - - Note : Before September 2020, this setting is available but not enforced. - The AutoForwardingMode specifies how the policy controls automatic email forwarding to outbound recipients. Valid values are: - - Automatic: Automatic external email forwarding is blocked by the system. This is the default value. - - On: Automatic external email forwarding is not restricted. - - Off: Automatic external email forwarding is disabled and will result in a non-delivery report (also known as an NDR or bounce message) to the sender. - - This setting applies only to cloud-based mailboxes, and automatic forwarding to internal recipients is not affected by this setting. - - AutoForwardingMode - - AutoForwardingMode - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - NotifyOutboundSpam - - Note : This setting has been replaced by the default alert policy named User restricted from sending email , which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see Verify the alert settings for restricted users (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - 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. - - Boolean - - Boolean - - - None - - - NotifyOutboundSpamRecipients - - Note : This setting has been replaced by the default alert policy named User restricted from sending email , which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see Verify the alert settings for restricted users (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecipientLimitExternalPerHour - - The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see Sending limits across Microsoft 365 options (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - - UInt32 - - UInt32 - - - None - - - RecipientLimitInternalPerHour - - The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see Sending limits across Microsoft 365 options (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). - - UInt32 - - UInt32 - - - None - - - RecipientLimitPerDay - - The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see Sending limits across Microsoft 365 options (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). - - UInt32 - - UInt32 - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterpolicy - - - - - - New-HostedOutboundSpamFilterRule - New - HostedOutboundSpamFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-HostedOutboundSpamFilterRule - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterrule - - - - - - New-InboundConnector - New - InboundConnector - - 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 : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Inbound connectors accept email messages from remote domains that require specific configuration options. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-InboundConnector - - Name - - The Name parameter specifies a descriptive name for the connector. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - CloudServicesMailEnabled - - Note : We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://docs.microsoft.com/exchange/hybrid-configuration-wizard). - 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. - - Boolean - - Boolean - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - TenantConnectorSource - - TenantConnectorSource - - - None - - - 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. - - TenantConnectorType - - TenantConnectorType - - - None - - - 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: - - 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 specify multiple IP addresses or address range entries separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EFSkipMailGateway - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EFTestMode - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Enabled - - The Enabled parameter enables or disables the connector. Valid input for this parameter is $true or $false. The default value is $true. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RestrictDomainsToCertificate - - The RestrictDomainsToCertificate parameter specifies that Microsoft 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ScanAndDropRecipients - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderIPAddresses - - The SenderIPAddresses parameter specifies the remote IPV4 IP addresses from which this connector accepts messages. IPv6 addresses are not supported. 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - TlsCertificate - - TlsCertificate - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a descriptive name for the connector. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - CloudServicesMailEnabled - - Note : We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://docs.microsoft.com/exchange/hybrid-configuration-wizard). - 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. - - Boolean - - Boolean - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - TenantConnectorSource - - TenantConnectorSource - - - None - - - 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. - - TenantConnectorType - - TenantConnectorType - - - None - - - 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: - - 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 specify multiple IP addresses or address range entries separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EFSkipMailGateway - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EFTestMode - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Enabled - - The Enabled parameter enables or disables the connector. Valid input for this parameter is $true or $false. The default value is $true. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RestrictDomainsToCertificate - - The RestrictDomainsToCertificate parameter specifies that Microsoft 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ScanAndDropRecipients - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderIPAddresses - - The SenderIPAddresses parameter specifies the remote IPV4 IP addresses from which this connector accepts messages. IPv6 addresses are not supported. 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - TlsCertificate - - TlsCertificate - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-inboundconnector - - - - - - New-InboxRule - New - InboxRule - - This cmdlet is available in 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-InboxRule cmdlet to create Inbox rules in mailboxes. Inbox rules process messages in the Inbox based on conditions and take actions such as moving a message to a specified folder or deleting a message. - You must have adequate permissions on the mailbox to create an Inbox rule. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules disabled by Microsoft Outlook and outbound rules are removed. - Parameters that are used for conditions also have corresponding exception parameters. When conditions specified in an exception are matched, the rule isn't applied to the message. Exception parameters begin with ExceptIf. For example, the exception parameter for SubjectOrBodyContainsWords is ExceptIfSubjectOrBodyContainsWords. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-InboxRule - - 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 ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - ApplyCategory - - The ApplyCategory parameter specifies an action for the Inbox rule that applies the specified category to messages. A valid value is any text value that you want to define as a category. You can specify multiple categories separated by commas. If the value contains spaces, enclose the value in quotation marks ("). - The categories that you specify for this parameter are defined in the mailbox (they aren't shared between mailboxes). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - CopyToFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - DeleteMessage - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - The corresponding condition parameter to this exception is BodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfFlaggedForAction - - 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. - - String - - String - - - None - - - 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 - - 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"`. - The corresponding condition parameter to this exception is From. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - The corresponding condition parameter to this exception is FromAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - ExceptIfHasAttachment - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfHasClassification - - The ExceptIfHasClassification parameter specifies an exception for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. - The corresponding condition parameter to this exception is HasClassification. - - MessageClassificationIdParameter[] - - MessageClassificationIdParameter[] - - - None - - - 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. - The corresponding condition parameter to this exception is HeaderContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfMessageTypeMatches - - 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. - - InboxRuleMessageType - - InboxRuleMessageType - - - None - - - ExceptIfMyNameInCcBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameInToBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameInToOrCcBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameNotInToBox - - 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. - - Boolean - - Boolean - - - None - - - 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". - The corresponding condition parameter to this exception is ReceivedAfterDate. - - ExDateTime - - ExDateTime - - - None - - - 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". - The corresponding condition parameter to this exception is ReceivedBeforeDate. - - ExDateTime - - ExDateTime - - - None - - - 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. - The corresponding condition parameter to this exception is RecipientAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSentOnlyToMe - - 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. - - Boolean - - Boolean - - - None - - - 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"`. - The corresponding condition parameter to this exception is SentTo. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - The corresponding condition parameter to this exception is SubjectContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - The corresponding condition parameter to this exception is ExceptIfSubjectOrBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfWithImportance - - 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. - - Importance - - Importance - - - None - - - ExceptIfWithinSizeRangeMaximum - - The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for the Inbox rule that looks for messages that smaller than specified maximum size. - When you enter a value, qualify the value with one of the following units: - - 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 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - ExceptIfWithinSizeRangeMinimum - - The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for the Inbox rule that looks for messages that are larger than the specified minimum size. - When you enter a value, qualify the value with one of the following units: - - 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 ExceptIfWithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of ExceptIfWithinSizeRangeMaximum. - The corresponding condition parameter to this exception is WithinSizeRangeMinimum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - ExceptIfWithSensitivity - - 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. - - Sensitivity - - Sensitivity - - - None - - - FlaggedForAction - - 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 - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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: - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - 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"`. - The corresponding exception parameter to this condition is ExceptIfFrom. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfFromAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - HasClassification - - The HasClassification parameter specifies a condition for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. - The corresponding exception parameter to this condition is ExceptIfHasClassification. - - MessageClassificationIdParameter[] - - MessageClassificationIdParameter[] - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfHeaderContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - MarkAsRead - - 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. - - Boolean - - Boolean - - - None - - - MarkImportance - - The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - - Low - - Normal - - High - - Importance - - Importance - - - None - - - MessageTypeMatches - - 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. - - InboxRuleMessageType - - InboxRuleMessageType - - - None - - - MoveToFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - MyNameInCcBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameInToBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameInToOrCcBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameNotInToBox - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Priority - - The Priority parameter specifies a priority for the Inbox rule that determines the order of rule processing. A lower integer value indicates a higher priority, - - Int32 - - Int32 - - - None - - - 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". - The corresponding exception parameter to this condition is ExceptIfReceivedAfterDate. - - ExDateTime - - ExDateTime - - - None - - - 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". - The corresponding exception parameter to this condition is ExceptIfReceivedBeforeDate. - - ExDateTime - - ExDateTime - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfRecipientAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RedirectTo - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SendTextMessageNotificationTo - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SentOnlyToMe - - 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. - - Boolean - - Boolean - - - None - - - 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: - - 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"`. - The corresponding exception parameter to this condition is ExceptIfSentTo. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - StopProcessingRules - - 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). - - Boolean - - Boolean - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfSubjectContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfSubjectOrBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WithImportance - - 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. - - Importance - - Importance - - - None - - - WithinSizeRangeMaximum - - The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox rule that looks for messages that are smaller than specified maximum size. - When you enter a value, qualify the value with one of the following units: - - 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 WithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of WithinSizeRangeMinimum. - The corresponding exception parameter to this condition is ExceptIfWithinSizeRangeMaximum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - WithinSizeRangeMinimum - - The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox rule that looks for messages that are larger than the specified minimum size. - When you enter a value, qualify the value with one of the following units: - - 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 WithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of WithinSizeRangeMaximum. - The corresponding exception parameter to this condition is ExceptIfWithinSizeRangeMinimum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - WithSensitivity - - 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. - - Sensitivity - - Sensitivity - - - None - - - - New-InboxRule - - FromMessageId - - 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. - - MailboxStoreObjectIdParameter - - MailboxStoreObjectIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - 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. - - - SwitchParameter - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - FromMessageId - - 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. - - MailboxStoreObjectIdParameter - - MailboxStoreObjectIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ApplyCategory - - The ApplyCategory parameter specifies an action for the Inbox rule that applies the specified category to messages. A valid value is any text value that you want to define as a category. You can specify multiple categories separated by commas. If the value contains spaces, enclose the value in quotation marks ("). - The categories that you specify for this parameter are defined in the mailbox (they aren't shared between mailboxes). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - CopyToFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - DeleteMessage - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - The corresponding condition parameter to this exception is BodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfFlaggedForAction - - 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. - - String - - String - - - None - - - 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 - - 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"`. - The corresponding condition parameter to this exception is From. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - The corresponding condition parameter to this exception is FromAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - ExceptIfHasAttachment - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfHasClassification - - The ExceptIfHasClassification parameter specifies an exception for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. - The corresponding condition parameter to this exception is HasClassification. - - MessageClassificationIdParameter[] - - MessageClassificationIdParameter[] - - - None - - - 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. - The corresponding condition parameter to this exception is HeaderContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfMessageTypeMatches - - 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. - - InboxRuleMessageType - - InboxRuleMessageType - - - None - - - ExceptIfMyNameInCcBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameInToBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameInToOrCcBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameNotInToBox - - 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. - - Boolean - - Boolean - - - None - - - 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". - The corresponding condition parameter to this exception is ReceivedAfterDate. - - ExDateTime - - ExDateTime - - - None - - - 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". - The corresponding condition parameter to this exception is ReceivedBeforeDate. - - ExDateTime - - ExDateTime - - - None - - - 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. - The corresponding condition parameter to this exception is RecipientAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSentOnlyToMe - - 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. - - Boolean - - Boolean - - - None - - - 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"`. - The corresponding condition parameter to this exception is SentTo. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - The corresponding condition parameter to this exception is SubjectContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - The corresponding condition parameter to this exception is ExceptIfSubjectOrBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfWithImportance - - 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. - - Importance - - Importance - - - None - - - ExceptIfWithinSizeRangeMaximum - - The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for the Inbox rule that looks for messages that smaller than specified maximum size. - When you enter a value, qualify the value with one of the following units: - - 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 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - ExceptIfWithinSizeRangeMinimum - - The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for the Inbox rule that looks for messages that are larger than the specified minimum size. - When you enter a value, qualify the value with one of the following units: - - 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 ExceptIfWithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of ExceptIfWithinSizeRangeMaximum. - The corresponding condition parameter to this exception is WithinSizeRangeMinimum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - ExceptIfWithSensitivity - - 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. - - Sensitivity - - Sensitivity - - - None - - - FlaggedForAction - - 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 - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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: - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - 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"`. - The corresponding exception parameter to this condition is ExceptIfFrom. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfFromAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - HasClassification - - The HasClassification parameter specifies a condition for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. - The corresponding exception parameter to this condition is ExceptIfHasClassification. - - MessageClassificationIdParameter[] - - MessageClassificationIdParameter[] - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfHeaderContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - MarkAsRead - - 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. - - Boolean - - Boolean - - - None - - - MarkImportance - - The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - - Low - - Normal - - High - - Importance - - Importance - - - None - - - MessageTypeMatches - - 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. - - InboxRuleMessageType - - InboxRuleMessageType - - - None - - - MoveToFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - MyNameInCcBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameInToBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameInToOrCcBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameNotInToBox - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Priority - - The Priority parameter specifies a priority for the Inbox rule that determines the order of rule processing. A lower integer value indicates a higher priority, - - Int32 - - Int32 - - - None - - - 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". - The corresponding exception parameter to this condition is ExceptIfReceivedAfterDate. - - ExDateTime - - ExDateTime - - - None - - - 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". - The corresponding exception parameter to this condition is ExceptIfReceivedBeforeDate. - - ExDateTime - - ExDateTime - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfRecipientAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RedirectTo - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SendTextMessageNotificationTo - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SentOnlyToMe - - 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. - - Boolean - - Boolean - - - None - - - 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: - - 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"`. - The corresponding exception parameter to this condition is ExceptIfSentTo. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - StopProcessingRules - - 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). - - Boolean - - Boolean - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfSubjectContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - The corresponding exception parameter to this condition is ExceptIfSubjectOrBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WithImportance - - 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. - - Importance - - Importance - - - None - - - WithinSizeRangeMaximum - - The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox rule that looks for messages that are smaller than specified maximum size. - When you enter a value, qualify the value with one of the following units: - - 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 WithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of WithinSizeRangeMinimum. - The corresponding exception parameter to this condition is ExceptIfWithinSizeRangeMaximum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - WithinSizeRangeMinimum - - The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox rule that looks for messages that are larger than the specified minimum size. - When you enter a value, qualify the value with one of the following units: - - 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 WithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of WithinSizeRangeMaximum. - The corresponding exception parameter to this condition is ExceptIfWithinSizeRangeMinimum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - WithSensitivity - - 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. - - Sensitivity - - Sensitivity - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-InboxRule "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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-inboxrule - - - - - - New-InformationBarrierPolicy - New - InformationBarrierPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-InformationBarrierPolicy cmdlet to create information barrier policies in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Information barrier policies are not in effect until you set them to active status, and then apply the policies: - - (If needed): Define a policy to block communications between segments (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#scenario-1-block-communications-between-segments). - After all of your policies are defined: Apply information barrier policies (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#part-3-apply-information-barrier-policies). - For more information, see Information barrier policies (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-InformationBarrierPolicy - - 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 ("). - - String - - String - - - None - - - 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`. - - String - - String - - - None - - - SegmentAllowedFilter - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch doesn't work on this cmdlet. - - - SwitchParameter - - - 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.) - - - Inactive - Active - - EopInformationBarrierPolicyState - - EopInformationBarrierPolicyState - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - New-InformationBarrierPolicy - - 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 ("). - - String - - String - - - None - - - 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`. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch doesn't work on this cmdlet. - - - SwitchParameter - - - 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.) - - - Inactive - Active - - EopInformationBarrierPolicyState - - EopInformationBarrierPolicyState - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - New-InformationBarrierPolicy - - 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 ("). - - String - - String - - - None - - - 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`. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch doesn't work on this cmdlet. - - - SwitchParameter - - - 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.) - - - Inactive - Active - - EopInformationBarrierPolicyState - - EopInformationBarrierPolicyState - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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`. - - String - - String - - - None - - - SegmentAllowedFilter - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch doesn't work on this cmdlet. - - SwitchParameter - - SwitchParameter - - - 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.) - - EopInformationBarrierPolicyState - - EopInformationBarrierPolicyState - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - New-InformationBarrierPolicy -Name "Manufacturing-HR" -AssignedSegment "Manufacturing" -SegmentsAllowed "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 -------------------------- - New-InformationBarrierPolicy -Name "Research-HRManufacturing" -AssignedSegment "Research" -SegmentsAllowed "HR","Manufacturing" -State Inactive - - This example creates a policy that allows the Research segment to communicate with only HR and Manufacturing . - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - - - - New-Label - New - Label - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-Label cmdlet to create sensitivity labels in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-Label - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - AdvancedSettings - - The AdvancedSettings parameter enables client-specific features and capabilities for a sensitivity label. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see Custom configurations for the Azure Information Protection unified labeling client (https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - ApplyWaterMarkingLayout - - The ApplyWaterMarkingAlignment 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout - - - None - - - 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. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Conditions - - This parameter is reserved for internal Microsoft use. - - - - - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - String - - String - - - None - - - EncryptionEnabled - - The EncryptionEnabled parameter specifies whether encryption in enabled. Value values are: - - $true: Encryption is enabled. - - $false: Encryption is disabled. - - System.Boolean - - System.Boolean - - - None - - - EncryptionEncryptOnly - - This parameter is reserved for internal Microsoft use. - - System.Boolean - - System.Boolean - - - None - - - EncryptionLinkedTemplateId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - EncryptionTemplateId - - The EncryptionTemplateId parameter links an existing Azure RMS template to a new label. - This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. - - String - - String - - - None - - - Identity - - The Identity parameter is used to migrate an existing Azure Information Protection label by specifying a GUID value. - - MasterIdParameter - - MasterIdParameter - - - None - - - LabelActions - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - LocaleSettings - - The LocaleSettings parameter specifies one or more localized label name 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"}]}` - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MigrationId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - Setting - - This parameter is reserved for internal Microsoft use. - - PswsHashtable - - PswsHashtable - - - None - - - Settings - - This parameter is reserved for internal Microsoft use. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType - - Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType - - - None - - - 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 - - This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. - - Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType - - Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - AdvancedSettings - - The AdvancedSettings parameter enables client-specific features and capabilities for a sensitivity label. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see Custom configurations for the Azure Information Protection unified labeling client (https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - ApplyWaterMarkingLayout - - The ApplyWaterMarkingAlignment 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout - - - None - - - 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. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Conditions - - This parameter is reserved for internal Microsoft use. - - - - - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - String - - String - - - None - - - EncryptionEnabled - - The EncryptionEnabled parameter specifies whether encryption in enabled. Value values are: - - $true: Encryption is enabled. - - $false: Encryption is disabled. - - System.Boolean - - System.Boolean - - - None - - - EncryptionEncryptOnly - - This parameter is reserved for internal Microsoft use. - - System.Boolean - - System.Boolean - - - None - - - EncryptionLinkedTemplateId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - EncryptionTemplateId - - The EncryptionTemplateId parameter links an existing Azure RMS template to a new label. - This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. - - String - - String - - - None - - - Identity - - The Identity parameter is used to migrate an existing Azure Information Protection label by specifying a GUID value. - - MasterIdParameter - - MasterIdParameter - - - None - - - LabelActions - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - LocaleSettings - - The LocaleSettings parameter specifies one or more localized label name 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"}]}` - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MigrationId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - Setting - - This parameter is reserved for internal Microsoft use. - - PswsHashtable - - PswsHashtable - - - None - - - Settings - - This parameter is reserved for internal Microsoft use. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - System.Boolean - - System.Boolean - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType - - Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance/new-label - - - - - - New-LabelPolicy - New - LabelPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-LabelPolicy cmdlet to create sensitivity label policies in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-LabelPolicy - - 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 ("). - - String - - String - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AdvancedSettings - - The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see Custom configurations for the Azure Information Protection unified labeling client (https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). - - PswsHashtable - - PswsHashtable - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ModernGroupLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AdvancedSettings - - The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see Custom configurations for the Azure Information Protection unified labeling client (https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). - - PswsHashtable - - PswsHashtable - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ModernGroupLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-labelpolicy - - - - - - New-MalwareFilterPolicy - New - MalwareFilterPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the MalwareFilterPolicy parameter on the New-MalwareFilterRule or Set-MalwareFilterRule cmdlets to associate the policy with a rule. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MalwareFilterPolicy - - Name - - The Name parameter specifies a name for the malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - CustomAlertText - - The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the Action parameter value is ReplaceWithCustomAlert. - - String - - String - - - None - - - CustomExternalBody - - The CustomExternalBody parameter specifies the body of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableExternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomExternalSubject - - The CustomExternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableExternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomFromAddress - - The CustomFromAddress parameter specifies the From address of the custom notification message for malware detections in messages from internal or external senders. - This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: - - EnableExternalSenderAdminNotifications - - EnableInternalSenderAdminNotifications - - SmtpAddress - - SmtpAddress - - - None - - - CustomFromName - - The CustomFromName parameter specifies the From name of the custom notification message for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: - - EnableExternalSenderAdminNotifications - - EnableInternalSenderAdminNotifications - - String - - String - - - None - - - CustomInternalBody - - The CustomInternalBody parameter specifies the body of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableInternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomInternalSubject - - The CustomInternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableInternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomNotifications - - The CustomNotifications parameter enables or disables custom notification messages for malware detections in messages from internal or external senders. Valid values are: - - $true: When malware is detected in a message, a custom notification message is sent to the message sender. You specify the details of message using the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. - - $false: Custom notifications to the original message sender are disabled. This is the default value. Default notification messages are sent if the EnableExternalSenderNotifications and EnableInternalSenderNotifications parameters are set to $true. - - Boolean - - Boolean - - - None - - - EnableExternalSenderAdminNotifications - - The EnableExternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from external senders. Valid values are: - - $true: When malware is detected in messages from external senders, send notification messages to the email address that's specified by the ExternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. - - $false: When malware is detected in messages from external senders, don't send administrator notifications. This is the default value. - - Boolean - - Boolean - - - None - - - EnableFileFilter - - This parameter is available only in the cloud-based service. - The EnableFileFilter parameter enables or disables common attachment blocking (also known as the Common Attachment Types Filter). Valid values are: - - $true: Common attachment blocking is enabled. The file types are defined by the FileTypes parameter. - - $false: Common attachment blocking is disabled. This is the default value. - - Boolean - - Boolean - - - None - - - EnableInternalSenderAdminNotifications - - The EnableInternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from internal senders. Valid values are: - - $true: When malware is detected in messages from internal senders, send notification messages to the email address that's specified by the InternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. - - $false: When malware is detected in messages from internal senders, don't send administrator notifications. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - FileTypeAction - - The FileTypeAction parameter specifies the action applied to the message when any of the attachment(s) has an extension which is in the list in the FileTypes parameter. - This parameter is only meaningful when the EnableFileFilter parameter value is $true. - Valid values are: - - Quarantine: Handles the message without notifying the recipients. In Exchange Server, the message is deleted. In the cloud-based service, the message is quarantined. - - Reject: Rejects the message with an NDR (Non Delivery Receipt) to the sender of the message. This is the default action. As the message is rejected, there will be no copy of the message in the Quarantine. - - FileTypeFilteringAction - - FileTypeFilteringAction - - - None - - - FileTypes - - This parameter is available only in the cloud-based service. - The FileTypes parameter specifies the file types that are automatically blocked by common attachment blocking (also known as the Common Attachment Types Filter), regardless of content. The default values are: - - .ace - - .ani - - .app - - .cab - - .docm - - .exe - - .iso - - .jar - - .jnlp - - .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. - - String[] - - String[] - - - None - - - InternalSenderAdminAddress - - The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from internal senders. - This parameter is only meaningful if the EnableInternalSenderAdminNotifications parameter value is $true. - - SmtpAddress - - SmtpAddress - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - Name - - The Name parameter specifies a name for the malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - CustomAlertText - - The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the Action parameter value is ReplaceWithCustomAlert. - - String - - String - - - None - - - CustomExternalBody - - The CustomExternalBody parameter specifies the body of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableExternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomExternalSubject - - The CustomExternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableExternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomFromAddress - - The CustomFromAddress parameter specifies the From address of the custom notification message for malware detections in messages from internal or external senders. - This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: - - EnableExternalSenderAdminNotifications - - EnableInternalSenderAdminNotifications - - SmtpAddress - - SmtpAddress - - - None - - - CustomFromName - - The CustomFromName parameter specifies the From name of the custom notification message for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: - - EnableExternalSenderAdminNotifications - - EnableInternalSenderAdminNotifications - - String - - String - - - None - - - CustomInternalBody - - The CustomInternalBody parameter specifies the body of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableInternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomInternalSubject - - The CustomInternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableInternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomNotifications - - The CustomNotifications parameter enables or disables custom notification messages for malware detections in messages from internal or external senders. Valid values are: - - $true: When malware is detected in a message, a custom notification message is sent to the message sender. You specify the details of message using the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. - - $false: Custom notifications to the original message sender are disabled. This is the default value. Default notification messages are sent if the EnableExternalSenderNotifications and EnableInternalSenderNotifications parameters are set to $true. - - Boolean - - Boolean - - - None - - - EnableExternalSenderAdminNotifications - - The EnableExternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from external senders. Valid values are: - - $true: When malware is detected in messages from external senders, send notification messages to the email address that's specified by the ExternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. - - $false: When malware is detected in messages from external senders, don't send administrator notifications. This is the default value. - - Boolean - - Boolean - - - None - - - EnableFileFilter - - This parameter is available only in the cloud-based service. - The EnableFileFilter parameter enables or disables common attachment blocking (also known as the Common Attachment Types Filter). Valid values are: - - $true: Common attachment blocking is enabled. The file types are defined by the FileTypes parameter. - - $false: Common attachment blocking is disabled. This is the default value. - - Boolean - - Boolean - - - None - - - EnableInternalSenderAdminNotifications - - The EnableInternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from internal senders. Valid values are: - - $true: When malware is detected in messages from internal senders, send notification messages to the email address that's specified by the InternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. - - $false: When malware is detected in messages from internal senders, don't send administrator notifications. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - FileTypeAction - - The FileTypeAction parameter specifies the action applied to the message when any of the attachment(s) has an extension which is in the list in the FileTypes parameter. - This parameter is only meaningful when the EnableFileFilter parameter value is $true. - Valid values are: - - Quarantine: Handles the message without notifying the recipients. In Exchange Server, the message is deleted. In the cloud-based service, the message is quarantined. - - Reject: Rejects the message with an NDR (Non Delivery Receipt) to the sender of the message. This is the default action. As the message is rejected, there will be no copy of the message in the Quarantine. - - FileTypeFilteringAction - - FileTypeFilteringAction - - - None - - - FileTypes - - This parameter is available only in the cloud-based service. - The FileTypes parameter specifies the file types that are automatically blocked by common attachment blocking (also known as the Common Attachment Types Filter), regardless of content. The default values are: - - .ace - - .ani - - .app - - .cab - - .docm - - .exe - - .iso - - .jar - - .jnlp - - .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. - - String[] - - String[] - - - None - - - InternalSenderAdminAddress - - The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from internal senders. - This parameter is only meaningful if the EnableInternalSenderAdminNotifications parameter value is $true. - - SmtpAddress - - SmtpAddress - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-malwarefilterpolicy - - - - - - New-MalwareFilterRule - New - MalwareFilterRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-MalwareFilterRule - - Name - - The Name parameter specifies a unique name for the malware filter rule. - - String - - String - - - None - - - MalwareFilterPolicy - - The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule 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. - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - MalwareFilterPolicy - - The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule 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. - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - Name - - The Name parameter specifies a unique name for the malware filter rule. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-malwarefilterrule - - - - - - New-OutboundConnector - New - OutboundConnector - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Outbound connectors send email messages to remote domains that require specific configuration options. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-OutboundConnector - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - CloudServicesMailEnabled - - Note : We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://docs.microsoft.com/exchange/hybrid-configuration-wizard). - 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. - - Boolean - - Boolean - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - TenantConnectorSource - - TenantConnectorSource - - - None - - - 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. - - TenantConnectorType - - TenantConnectorType - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - LinkForModifiedConnector - - This parameter is reserved for internal Microsoft use. - - Guid - - Guid - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - SmtpDomainWithSubdomains - - SmtpDomainWithSubdomains - - - None - - - 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. - - TlsAuthLevel - - TlsAuthLevel - - - None - - - 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 specify the smart hosts by using the SmartHosts parameter in the same command. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - CloudServicesMailEnabled - - Note : We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://docs.microsoft.com/exchange/hybrid-configuration-wizard). - 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. - - Boolean - - Boolean - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - TenantConnectorSource - - TenantConnectorSource - - - None - - - 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. - - TenantConnectorType - - TenantConnectorType - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - LinkForModifiedConnector - - This parameter is reserved for internal Microsoft use. - - Guid - - Guid - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - SmtpDomainWithSubdomains - - SmtpDomainWithSubdomains - - - None - - - 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. - - TlsAuthLevel - - TlsAuthLevel - - - None - - - 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 specify the smart hosts by using the SmartHosts parameter in the same command. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-outboundconnector - - - - - - New-PolicyTipConfig - New - PolicyTipConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-PolicyTipConfig - - Name - - The Name parameter specifies the custom Policy Tip you want to modify. Valid input for this parameter is one of the following values: - - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the custom Policy Tip you want to modify. Valid input for this parameter is one of the following values: - - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 "https://www.contoso.com/PolicyTipInformation" - - This example sets the informational URL in Policy Tips to the value `https://www.contoso.com/PolicyTipInformation`. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-policytipconfig - - - - - - New-ProtectionAlert - New - ProtectionAlert - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-ProtectionAlert - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - Name - - The Name parameter specifies the unique name for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ThreatAlertType - - ThreatAlertType - - - None - - - 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. - - AlertAggregationType - - AlertAggregationType - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AlertFor - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies descriptive text for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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 (for example, `500`, `$true`, `$false`, or `$null`). - You can chain multiple search criteria together using the logical `-and` operator (for example, `"Criteria1 -and Criteria2"`). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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 - - String - - String - - - None - - - NotificationCulture - - The NotificationCulture parameter specifies the language or locale that's used for notifications. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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). - - Int32 - - Int32 - - - None - - - 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). - - Int32 - - Int32 - - - None - - - Operation - - The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can specify multiple values separated by commas. - You can only use this parameter when the ThreatType parameter has the value Activity. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Severity - - The Severity parameter specifies the severity of the detection. Valid values are: - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - Name - - The Name parameter specifies the unique name for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ThreatAlertType - - ThreatAlertType - - - None - - - 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. - - AlertAggregationType - - AlertAggregationType - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AlertFor - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies descriptive text for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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 (for example, `500`, `$true`, `$false`, or `$null`). - You can chain multiple search criteria together using the logical `-and` operator (for example, `"Criteria1 -and Criteria2"`). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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 - - String - - String - - - None - - - NotificationCulture - - The NotificationCulture parameter specifies the language or locale that's used for notifications. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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). - - Int32 - - Int32 - - - None - - - 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). - - Int32 - - Int32 - - - None - - - Operation - - The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can specify multiple values separated by commas. - You can only use this parameter when the ThreatType parameter has the value Activity. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Severity - - The Severity parameter specifies the severity of the detection. Valid values are: - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 Security & Compliance Center. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-protectionalert - - - - - - New-RetentionCompliancePolicy - New - RetentionCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - New policies are not valid and will not be applied until a retention rule is added to the policy. For more information, see New-RetentionComplianceRule (New-RetentionComplianceRule.md). In addition, at least one location parameter must be defined to create a retention policy. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-RetentionCompliancePolicy - - Name - - The Name parameter specifies the unique name of the retention policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DynamicScopeLocation - - {{Fill DynamicScopeLocation Description}} - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - You 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ModernGroupLocationException - - The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SkypeLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - New-RetentionCompliancePolicy - - Name - - The Name parameter specifies the unique name of the retention policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the unique name of the retention policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DynamicScopeLocation - - {{Fill DynamicScopeLocation Description}} - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - You 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ModernGroupLocationException - - The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SkypeLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-RetentionCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -New-RetentionComplianceRule -Name RetUnlimited -Policy "Regulation 123 Compliance" -RetentionDuration Unlimited - - The first command in 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. The second command creates a new retention rule named "RetUnlimited" and adds it to the retention policy created with the fist command. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancepolicy - - - - - - New-RetentionComplianceRule - New - RetentionComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-RetentionComplianceRule - - 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. - - String - - String - - - None - - - Policy - - The Policy parameter specifies the policy to contain the rule. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.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. - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - You can't use this parameter for Teams retention rules. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - RetentionComplianceAction - - The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - - Delete - - Keep - - KeepAndDelete - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - New-RetentionComplianceRule - - 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. - - String - - String - - - None - - - Policy - - The Policy parameter specifies the policy to contain the rule. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - You can't use this parameter for Teams retention rules. - - String - - String - - - None - - - 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://docs.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes)and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - RetentionComplianceAction - - The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - - Delete - - Keep - - KeepAndDelete - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - You can't use this parameter for Teams retention rules. - - HoldDurationHint - - HoldDurationHint - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - New-RetentionComplianceRule - - Policy - - The Policy parameter specifies the policy to contain the rule. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - You can't use this parameter for Teams retention rules. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - RetentionComplianceAction - - The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - - Delete - - Keep - - KeepAndDelete - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - Policy - - The Policy parameter specifies the policy to contain the rule. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - You can't use this parameter for Teams retention rules. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.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. - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - You can't use this parameter for Teams retention rules. - - String - - String - - - None - - - 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://docs.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes)and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - RetentionComplianceAction - - The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - - Delete - - Keep - - KeepAndDelete - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - You can't use this parameter for Teams retention rules. - - HoldDurationHint - - HoldDurationHint - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancerule - - - - - - New-SafeAttachmentPolicy - New - SafeAttachmentPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - 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 SafeAttachmentPolicy parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets to associate the policy with a rule. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-SafeAttachmentPolicy - - Name - - The Name parameter specifies a unique name for the Safe Attachments policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Action - - The Action parameter specifies the action for the Safe Attachments policy. Valid values are: - - Allow: Attachments aren't scanned by Safe Attachments policies. - - Block: Block the email message that contains the malware attachment. This is the default value. - - Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. - - DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see How Dynamic Delivery works (https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). - The results of all actions are available in message trace. - - SafeAttachmentAction - - SafeAttachmentAction - - - None - - - 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. This is the default value. - - $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. - - Boolean - - Boolean - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enable - - This parameter isn't used. To enable or disable a safe attachment policy, use the Enabled parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RedirectAddress - - The RedirectAddress parameter specifies the email address where detected malware attachments are sent when the Redirect parameter is set to the value $true. - - SmtpAddress - - SmtpAddress - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the Safe Attachments policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Action - - The Action parameter specifies the action for the Safe Attachments policy. Valid values are: - - Allow: Attachments aren't scanned by Safe Attachments policies. - - Block: Block the email message that contains the malware attachment. This is the default value. - - Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. - - DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see How Dynamic Delivery works (https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). - The results of all actions are available in message trace. - - SafeAttachmentAction - - SafeAttachmentAction - - - None - - - 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. This is the default value. - - $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. - - Boolean - - Boolean - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enable - - This parameter isn't used. To enable or disable a safe attachment policy, use the Enabled parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RedirectAddress - - The RedirectAddress parameter specifies the email address where detected malware attachments are sent when the Redirect parameter is set to the value $true. - - SmtpAddress - - SmtpAddress - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-SafeAttachmentPolicy -Name "Marketing Block Attachments" -Redirect $true -RedirectAddress admin@contoso.com - - This example creates a new Safe Attachments 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. - - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-safeattachmentpolicy - - - - - - New-SafeAttachmentRule - New - SafeAttachmentRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to specify at least one condition for the rule. - You need to add the safe attachment rule to an existing policy by using the SafeAttachmentPolicy parameter. You create safe attachment policies by using the New-SafeAttachmentPolicy cmdlet. - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-SafeAttachmentRule - - Name - - The Name parameter specifies a unique name for the safe attachment rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the rule is enabled. Valid values are: - - $true: The rule is enabled. Ths 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the rule is enabled. Valid values are: - - $true: The rule is enabled. Ths 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-safeattachmentrule - - - - - - New-SafeLinksPolicy - New - SafeLinksPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the SafeLinksPolicy parameter on the New-SafeLinksRule or Set-SafeLinksRule cmdlets to associate the policy with a rule. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-SafeLinksPolicy - - Name - - The Name parameter specifies a unique name for the Safe Links policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 isn allowed to click through to the original URL. This is the default value. - - $false: The user isn't allowed to click through to the original URL. - - Boolean - - Boolean - - - True - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DeliverMessageAfterScan - - The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: - - $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. - - $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. - - Boolean - - Boolean - - - False - - - DisableUrlRewrite - - The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: - - $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). Typically, we don't recommend using this value. - - $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This is the default value. - - Boolean - - Boolean - - - 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://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EnableForInternalSenders - - The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: - - $true: The policy is applied to internal and external senders. - - $false: The policy is applied only to external senders. This is the default value. - - Boolean - - Boolean - - - False - - - EnableOrganizationBranding - - The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in Customize the Microsoft 365 theme for your organization(https://docs.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. - - $false: Organization branding is not displayed on Safe Links warning and notification pages. - - Boolean - - Boolean - - - None - - - EnableSafeLinksForEmail - - The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: - - $true: Safe Links is enabled for email. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - - $false: Safe Links isn't enabled for email. This is the default value. - - Boolean - - Boolean - - - False - - - EnableSafeLinksForTeams - - Note : As of March 2020, this parameter is in Preview and is available only for members of the Microsoft Teams Technology Adoption Program (TAP). - The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: - - $true: Safe Links is enabled for Teams. If a protected user clicks a malicious link in a Teams conversation, group chat, or from channels, a warning page will appear in the default web browser. - - $false: Safe Links isn't enabled for Teams. This is the default value. - - Boolean - - Boolean - - - False - - - MakeBuiltInProtection - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - RecommendedPolicyType - - The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of Preset security policies(https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this parameter yourself. - - RecommendedPolicyType - - RecommendedPolicyType - - - None - - - 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 in email messages, including links that point to files, is enabled. - - $false: Real-time scanning of clicked links in email messages, including links that point to files, is disabled. This is the default value. - - Boolean - - Boolean - - - False - - - TrackClicks - - The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links in email messages. Valid values are: - - $true: User clicks in email messages are tracked. This is the default value. - - $false: User clicks in email messages aren't tracked. - - Boolean - - Boolean - - - True - - - 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. - - Boolean - - Boolean - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a unique name for the Safe Links policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 isn allowed to click through to the original URL. This is the default value. - - $false: The user isn't allowed to click through to the original URL. - - Boolean - - Boolean - - - True - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DeliverMessageAfterScan - - The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: - - $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. - - $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. - - Boolean - - Boolean - - - False - - - DisableUrlRewrite - - The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: - - $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). Typically, we don't recommend using this value. - - $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This is the default value. - - Boolean - - Boolean - - - 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://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EnableForInternalSenders - - The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: - - $true: The policy is applied to internal and external senders. - - $false: The policy is applied only to external senders. This is the default value. - - Boolean - - Boolean - - - False - - - EnableOrganizationBranding - - The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in Customize the Microsoft 365 theme for your organization(https://docs.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. - - $false: Organization branding is not displayed on Safe Links warning and notification pages. - - Boolean - - Boolean - - - None - - - EnableSafeLinksForEmail - - The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: - - $true: Safe Links is enabled for email. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - - $false: Safe Links isn't enabled for email. This is the default value. - - Boolean - - Boolean - - - False - - - EnableSafeLinksForTeams - - Note : As of March 2020, this parameter is in Preview and is available only for members of the Microsoft Teams Technology Adoption Program (TAP). - The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: - - $true: Safe Links is enabled for Teams. If a protected user clicks a malicious link in a Teams conversation, group chat, or from channels, a warning page will appear in the default web browser. - - $false: Safe Links isn't enabled for Teams. This is the default value. - - Boolean - - Boolean - - - False - - - MakeBuiltInProtection - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - RecommendedPolicyType - - The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of Preset security policies(https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this parameter yourself. - - RecommendedPolicyType - - RecommendedPolicyType - - - None - - - 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 in email messages, including links that point to files, is enabled. - - $false: Real-time scanning of clicked links in email messages, including links that point to files, is disabled. This is the default value. - - Boolean - - Boolean - - - False - - - TrackClicks - - The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links in email messages. Valid values are - - $true: User clicks in email messages are tracked. This is the default value. - - $false: User clicks in email messages aren't tracked. - - Boolean - - Boolean - - - True - - - 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. - - Boolean - - Boolean - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-SafeLinksPolicy -Name "Marketing Block URL" -EnableSafeLinksForEmail $true -TrackClicks $true - - This example creates a new Safe Links policy named Marketing Block URL with the following options: - - The policy is enabled on Outlook. - - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-safelinkspolicy - - - - - - New-SafeLinksRule - New - SafeLinksRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-SafeLinksRule - - Name - - The Name parameter specifies a unique name for the Safe Links rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - The rule doesn't apply to members of the group named Research Department Managers. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-safelinksrule - - - - - - New-SupervisoryReviewPolicyV2 - New - SupervisoryReviewPolicyV2 - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-SupervisoryReviewPolicyV2 cmdlet to create supervisory review policies in the 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-SupervisoryReviewPolicyV2 - - 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 ("). - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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. - - String[] - - String[] - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-supervisoryreviewpolicyv2 - - - - - - New-SupervisoryReviewRule - New - SupervisoryReviewRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-SupervisoryReviewRule cmdlet to create supervisory review rules in the 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-SupervisoryReviewRule - - 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 ("). - - String - - String - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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))"`. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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))"`. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-supervisoryreviewrule - - - - - - New-SweepRule - New - SweepRule - - This cmdlet is available in 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. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-SweepRule - - Name - - The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - Provider - - The Provider parameter specifies the provider for the Sweep rule. If the value contains spaces, enclose the value in quotation marks. - For Sweep rules that you create in Outlook on the web, the default value is Exchange16. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DestinationFolder - - The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. - For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - Enabled - - 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. - - Boolean - - Boolean - - - None - - - KeepForDays - - The KeepForDays parameter specifies an action for the Sweep rule that specifies the number of days to keep messages that match the conditions of the rule. After the number of days have passed, the messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). - You can't use this parameter with the KeepLatest parameter and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. - - Int32 - - Int32 - - - None - - - KeepLatest - - The KeepLatest parameter specifies an action for the Sweep rule that specifies the number of messages to keep that match the conditions of the rule. After the number of messages is exceeded, the oldest messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). - You can't use this parameter with the KeepForDays parameter and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. - - Int32 - - Int32 - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - For external senders, use their email address. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - SourceFolder - - The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. - For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - SystemCategory - - 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 - - SystemCategoryType - - SystemCategoryType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - Provider - - The Provider parameter specifies the provider for the Sweep rule. If the value contains spaces, enclose the value in quotation marks. - For Sweep rules that you create in Outlook on the web, the default value is Exchange16. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DestinationFolder - - The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. - For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - Enabled - - 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. - - Boolean - - Boolean - - - None - - - KeepForDays - - The KeepForDays parameter specifies an action for the Sweep rule that specifies the number of days to keep messages that match the conditions of the rule. After the number of days have passed, the messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). - You can't use this parameter with the KeepLatest parameter and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. - - Int32 - - Int32 - - - None - - - KeepLatest - - The KeepLatest parameter specifies an action for the Sweep rule that specifies the number of messages to keep that match the conditions of the rule. After the number of messages is exceeded, the oldest messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). - You can't use this parameter with the KeepForDays parameter and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. - - Int32 - - Int32 - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - For external senders, use their email address. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - SourceFolder - - The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. - For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - SystemCategory - - 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 - - SystemCategoryType - - SystemCategoryType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-sweeprule - - - - - - New-TenantAllowBlockListItems - New - TenantAllowBlockListItems - - Note : The features described in this topic are in Preview, are subject to change, and are not available in all organizations. - 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 Security & Compliance Center. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-TenantAllowBlockListItems - - Action - - The Action parameter specifies the action type for the entry. Valid values are: - - Allow - - Block - - ItemAction - - ItemAction - - - None - - - Entries - - The Entries parameter specifies the URL or files that you want to add to the Tenant Allow/Block List based on the value of the ListType parameter: - - URLs: Use IPv4 or IPv6 addresses or hostnames. Wildcards (* and ~) are supported in hostnames. Protocols, TCP/UDP ports, or user credentials are not supported. For details, see URL syntax for the Tenant Allow/Block List (https://docs.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list#url-syntax-for-the-tenant-allowedblocked-list). - Files: Use the SHA256 hash value of the file. In Windows, you can find the SHA256 hash value by running the following command in a Command Prompt: `certutil.exe -hashfile "<Path><Filename>" SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. - To enter multiple values, use the following syntax: `"Value1","Value2",..."ValueN"`. - You can't mix URL and file values or allow and block actions in the same command. You can't modify existing URL or file values after you create the entry (there's no Entries parameter on the Set-TenantAllowBlockListItems cmdlet). - - String[] - - String[] - - - None - - - 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, `"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/2020 9:30 AM").ToUniversalTime()`. For more information, see Get-Date (https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - You can't use this parameter with the NoExpiration switch. - - DateTime - - DateTime - - - None - - - ListType - - The ListType parameter specifies the type of entry to add. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - - New-TenantAllowBlockListItems - - Action - - The Action parameter specifies the action type for the entry. Valid values are: - - Allow - - Block - - ItemAction - - ItemAction - - - None - - - Entries - - The Entries parameter specifies the URL or files that you want to add to the Tenant Allow/Block List based on the value of the ListType parameter: - - URLs: Use IPv4 or IPv6 addresses or hostnames. Wildcards (* and ~) are supported in hostnames. Protocols, TCP/UDP ports, or user credentials are not supported. For details, see URL syntax for the Tenant Allow/Block List (https://docs.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list#url-syntax-for-the-tenant-allowedblocked-list). - Files: Use the SHA256 hash value of the file. In Windows, you can find the SHA256 hash value by running the following command in a Command Prompt: `certutil.exe -hashfile "<Path><Filename>" SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. - To enter multiple values, use the following syntax: `"Value1","Value2",..."ValueN"`. - You can't mix URL and file values or allow and block actions in the same command. You can't modify existing URL or file values after you create the entry (there's no Entries parameter on the Set-TenantAllowBlockListItems cmdlet). - - String[] - - String[] - - - None - - - ListType - - The ListType parameter specifies the type of entry to add. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - NoExpiration - - The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. - You can't use this switch with the ExpirationDate parameter. - - - SwitchParameter - - - False - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - Action - - The Action parameter specifies the action type for the entry. Valid values are: - - Allow - - Block - - ItemAction - - ItemAction - - - None - - - Entries - - The Entries parameter specifies the URL or files that you want to add to the Tenant Allow/Block List based on the value of the ListType parameter: - - URLs: Use IPv4 or IPv6 addresses or hostnames. Wildcards (* and ~) are supported in hostnames. Protocols, TCP/UDP ports, or user credentials are not supported. For details, see URL syntax for the Tenant Allow/Block List (https://docs.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list#url-syntax-for-the-tenant-allowedblocked-list). - Files: Use the SHA256 hash value of the file. In Windows, you can find the SHA256 hash value by running the following command in a Command Prompt: `certutil.exe -hashfile "<Path><Filename>" SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. - To enter multiple values, use the following syntax: `"Value1","Value2",..."ValueN"`. - You can't mix URL and file values or allow and block actions in the same command. You can't modify existing URL or file values after you create the entry (there's no Entries parameter on the Set-TenantAllowBlockListItems cmdlet). - - String[] - - String[] - - - None - - - 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, `"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/2020 9:30 AM").ToUniversalTime()`. For more information, see Get-Date (https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - You can't use this parameter with the NoExpiration switch. - - DateTime - - DateTime - - - None - - - ListType - - The ListType parameter specifies the type of entry to add. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - NoExpiration - - The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. - You can't use this switch with the ExpirationDate parameter. - - SwitchParameter - - SwitchParameter - - - False - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-TenantAllowBlockListItem -ListType Url -Action 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 -------------------------- - New-TenantAllowBlockListItem -ListType FileHash -Action Allow -Entries "768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3","2c0a35409ff0873cfa28b70b8224e9aca2362241c1f0ed6f622fef8d4722fd9a" -NoExpiration - - This example adds a file allow entry for the specified files that never expires. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-tenantallowblocklistitems - - - - - - New-TransportRule - New - TransportRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-TransportRule - - 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 ("). - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 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. - - ADAttribute - - ADAttribute - - - None - - - 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 - - Evaluation - - Evaluation - - - None - - - 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. - - AddedRecipientType - - AddedRecipientType - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - DisclaimerFallbackAction - - DisclaimerFallbackAction - - - None - - - 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 at the beginning of the message body. - - If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. - - DisclaimerLocation - - DisclaimerLocation - - - None - - - 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). - - DisclaimerText - - DisclaimerText - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - 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://docs.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 2013 (https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). - - Boolean - - Boolean - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DlpPolicy - - The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see Data loss prevention in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - ADAttribute - - ADAttribute - - - None - - - 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 - - Evaluation - - Evaluation - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 2013 (https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). - - Boolean - - Boolean - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - 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). - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - FromUserScope - - FromUserScope - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - EvaluatedUser - - EvaluatedUser - - - None - - - ExceptIfMessageContainsAllDataClassifications - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Hashtable[] - - Hashtable[] - - - None - - - 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 in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). - - Hashtable[] - - Hashtable[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 on the web 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: Moderation request messages sent to moderators. - - ReadReceipt: Read receipts. - - MessageType - - MessageType - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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$'. - - Word[] - - Word[] - - - None - - - ExceptIfRecipientInSenderList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - ExceptIfSenderInRecipientList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ManagementRelationship - - ManagementRelationship - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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) - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - ToUserScope - - ToUserScope - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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 - - Importance - - Importance - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - 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). - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - FromUserScope - - FromUserScope - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - An incident report is generated for messages that violate a DLP policy in your organization. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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%% - - DisclaimerText - - DisclaimerText - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - IncidentReportContent[] - - IncidentReportContent[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - EvaluatedUser - - EvaluatedUser - - - None - - - MessageContainsAllDataClassifications - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Hashtable[] - - Hashtable[] - - - None - - - 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 in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). - You can specify the notification options by using the NotifySender parameter. - - Hashtable[] - - Hashtable[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 on the web 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: Moderation request messages sent to moderators. - - ReadReceipt: Read receipts. - - MessageType - - MessageType - - - None - - - 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. - - RuleMode - - RuleMode - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - NotifySenderType - - NotifySenderType - - - None - - - 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. - - SubjectPrefix - - SubjectPrefix - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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$'. - - Word[] - - Word[] - - - None - - - RecipientInSenderList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 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. - - RejectEnhancedStatus - - RejectEnhancedStatus - - - None - - - 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 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. - - RejectText - - RejectText - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - RuleErrorAction - - RuleErrorAction - - - None - - - 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. - - RuleSubType - - RuleSubType - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - SenderAddressLocation - - SenderAddressLocation - - - None - - - 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). - - Word[] - - Word[] - - - None - - - SenderInRecipientList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ManagementRelationship - - ManagementRelationship - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - ToUserScope - - ToUserScope - - - None - - - 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. - - String - - String - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - HeaderValue - - HeaderValue - - - None - - - 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. - - SclValue - - SclValue - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - Importance - - Importance - - - None - - - - - - 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 ("). - - String - - String - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 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. - - ADAttribute - - ADAttribute - - - None - - - 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 - - Evaluation - - Evaluation - - - None - - - 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. - - AddedRecipientType - - AddedRecipientType - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - DisclaimerFallbackAction - - DisclaimerFallbackAction - - - None - - - 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 at the beginning of the message body. - - If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. - - DisclaimerLocation - - DisclaimerLocation - - - None - - - 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). - - DisclaimerText - - DisclaimerText - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - 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://docs.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 2013 (https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). - - Boolean - - Boolean - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DlpPolicy - - The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see Data loss prevention in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - ADAttribute - - ADAttribute - - - None - - - 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 - - Evaluation - - Evaluation - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 2013 (https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). - - Boolean - - Boolean - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - 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). - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - FromUserScope - - FromUserScope - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - EvaluatedUser - - EvaluatedUser - - - None - - - ExceptIfMessageContainsAllDataClassifications - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Hashtable[] - - Hashtable[] - - - None - - - 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 in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). - - Hashtable[] - - Hashtable[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 on the web 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: Moderation request messages sent to moderators. - - ReadReceipt: Read receipts. - - MessageType - - MessageType - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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$'. - - Word[] - - Word[] - - - None - - - ExceptIfRecipientInSenderList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - ExceptIfSenderInRecipientList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ManagementRelationship - - ManagementRelationship - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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) - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - ToUserScope - - ToUserScope - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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 - - Importance - - Importance - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - 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). - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - FromUserScope - - FromUserScope - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - An incident report is generated for messages that violate a DLP policy in your organization. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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%% - - DisclaimerText - - DisclaimerText - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - IncidentReportContent[] - - IncidentReportContent[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - EvaluatedUser - - EvaluatedUser - - - None - - - MessageContainsAllDataClassifications - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Hashtable[] - - Hashtable[] - - - None - - - 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 in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). - You can specify the notification options by using the NotifySender parameter. - - Hashtable[] - - Hashtable[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 on the web 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: Moderation request messages sent to moderators. - - ReadReceipt: Read receipts. - - MessageType - - MessageType - - - None - - - 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. - - RuleMode - - RuleMode - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - NotifySenderType - - NotifySenderType - - - None - - - 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. - - SubjectPrefix - - SubjectPrefix - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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$'. - - Word[] - - Word[] - - - None - - - RecipientInSenderList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 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. - - RejectEnhancedStatus - - RejectEnhancedStatus - - - None - - - 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 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. - - RejectText - - RejectText - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - RuleErrorAction - - RuleErrorAction - - - None - - - 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. - - RuleSubType - - RuleSubType - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - SenderAddressLocation - - SenderAddressLocation - - - None - - - 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). - - Word[] - - Word[] - - - None - - - SenderInRecipientList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ManagementRelationship - - ManagementRelationship - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - ToUserScope - - ToUserScope - - - None - - - 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. - - String - - String - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - HeaderValue - - HeaderValue - - - None - - - 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. - - SclValue - - SclValue - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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 - - Importance - - Importance - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 Communication or the message was sent by Tony Smith or Pilar Ackerman. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-transportrule - - - - - - New-UnifiedAuditLogRetentionPolicy - New - UnifiedAuditLogRetentionPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the New-UnifiedAuditLogRetentionPolicy cmdlet to create audit log retention policies in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see Manage audit log retention policies (https://docs.microsoft.com/microsoft-365/compliance/audit-log-retention-policies). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - New-UnifiedAuditLogRetentionPolicy - - 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 ("). - - String - - String - - - None - - - Priority - - The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a higher priority, the value 10000 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 8 existing policies: - - Valid priority values for the existing 8 policies are from 7 through 0. - - Valid priority values for a new policy (the 9th policy) are from 8 through 0. - - You must use a unique priority value when creating new audit log retention policies. Any custom audit log retention policy that you create will take precedence over the default audit log retention policy. For more information, see Advanced audit in Microsoft 365 (https://docs.microsoft.com/microsoft-365/compliance/advanced-audit). - - Int32 - - Int32 - - - None - - - RetentionDuration - - The RetentionDuration parameter specifies how long audit log records are kept. Valid values are: - - ThreeMonths - - SixMonths - - NineMonths - - TwelveMonths - - TenYears - - - ThreeMonths - SixMonths - NineMonths - TwelveMonths - TenYears - - UnifiedAuditLogRetentionDuration - - UnifiedAuditLogRetentionDuration - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - Operations - - The Operations parameter specifies the audit log operations that are retained by the policy. For a list of the available values for this parameter, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecordTypes - - The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can specify multiple values separated by commas. If you specify more than one value, you can't use the Operations parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 ("). - - String - - String - - - None - - - Priority - - The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a higher priority, the value 10000 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 8 existing policies: - - Valid priority values for the existing 8 policies are from 7 through 0. - - Valid priority values for a new policy (the 9th policy) are from 8 through 0. - - You must use a unique priority value when creating new audit log retention policies. Any custom audit log retention policy that you create will take precedence over the default audit log retention policy. For more information, see Advanced audit in Microsoft 365 (https://docs.microsoft.com/microsoft-365/compliance/advanced-audit). - - Int32 - - Int32 - - - None - - - RetentionDuration - - The RetentionDuration parameter specifies how long audit log records are kept. Valid values are: - - ThreeMonths - - SixMonths - - NineMonths - - TwelveMonths - - TenYears - - UnifiedAuditLogRetentionDuration - - UnifiedAuditLogRetentionDuration - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - Operations - - The Operations parameter specifies the audit log operations that are retained by the policy. For a list of the available values for this parameter, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecordTypes - - The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can specify multiple values separated by commas. If you specify more than one value, you can't use the Operations parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-unifiedauditlogretentionpolicy - - - - - - Remove-ActivityAlert - Remove - ActivityAlert - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-ActivityAlert - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ActivityAlert -Identity "All Mailbox Activities" - - This example removes the activity alert named All Mailbox Activities. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-activityalert - - - - - - Remove-AntiPhishPolicy - Remove - AntiPhishPolicy - - This cmdlet is available only in the cloud-based service. - Use the Remove-AntiPhishPolicy cmdlet to remove antiphish policies from your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-AntiPhishPolicy - - 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 - - AntiPhishPolicyIdParameter - - AntiPhishPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - AntiPhishPolicyIdParameter - - AntiPhishPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AntiPhishPolicy -Identity "Quarantine Policy" - - This example removes the antiphish policy named Quarantine Policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-antiphishpolicy - - - - - - Remove-AntiPhishRule - Remove - AntiPhishRule - - This cmdlet is available only in the cloud-based service. - Use the Remove-AntiPhishRule cmdlet to remove antiphish rules from your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-AntiPhishRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AntiPhishRule -Identity "Research Department Phishing Rule" - - This examples removes the antiphish rule named Research Department Phishing Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-antiphishrule - - - - - - Remove-AuditConfigurationPolicy - Remove - AuditConfigurationPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-AuditConfigurationPolicy - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AuditConfigurationPolicy -Identity 8d4d2060-ee8e-46a8-8d72-24922956fba5 - - This example removes the audit configuration policy named 8d4d2060-ee8e-46a8-8d72-24922956fba5. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-auditconfigurationpolicy - - - - - - Remove-AuditConfigurationRule - Remove - AuditConfigurationRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-AuditConfigurationRule - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AuditConfigurationRule 989a3a6c-dc40-4fa4-8307-beb3ece992e9 - - This example removes the audit configuration rule named 989a3a6c-dc40-4fa4-8307-beb3ece992e9. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-auditconfigurationrule - - - - - - Remove-AutoSensitivityLabelPolicy - Remove - AutoSensitivityLabelPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-AutoSensitivityLabelPolicy cmdlet to remove auto-labeling policies from your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-AutoSensitivityLabelPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AutoSensitivityLabelPolicy -Identity "Marketing Group" - - This example removes the policy named Marketing Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelpolicy - - - - - - Remove-AutoSensitivityLabelRule - Remove - AutoSensitivityLabelRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-AutoSensitivityLabelPolicy cmdlet to remove auto-labeling policy rules from your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-AutoSensitivityLabelRule - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-AutoSensitivityLabelRule -Identity "Social Security Rule" - - This example removes the rule named Social Security Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelrule - - - - - - Remove-BlockedSenderAddress - Remove - BlockedSenderAddress - - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-BlockedSenderAddress - - SenderAddress - - The SenderAddress parameter specifies the email address of the user that you want to unblock. - - SmtpAddress - - SmtpAddress - - - None - - - 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 ("). - - String - - String - - - None - - - - - - SenderAddress - - The SenderAddress parameter specifies the email address of the user that you want to unblock. - - SmtpAddress - - SmtpAddress - - - None - - - 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 ("). - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-BlockedSenderAddress -SenderAddress julia@contoso.com - - This example unblocks the user julia@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-blockedsenderaddress - - - - - - Remove-CaseHoldPolicy - Remove - CaseHoldPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-CaseHoldPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-CaseHoldPolicy -Identity "Regulation 123 Compliance" - - This example removes the case hold policy named "Regulation 123 Compliance". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-caseholdpolicy - - - - - - Remove-CaseHoldRule - Remove - CaseHoldRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-CaseHoldRule - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-CaseHoldRule -Identity "One Year Standard" - - This example removes the case hold rule named "One Year Standard". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-caseholdrule - - - - - - Remove-ComplianceRetentionEventType - Remove - ComplianceRetentionEventType - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ComplianceRetentionEventType - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the retention event type. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the retention event type. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ComplianceRetentionEventType -Identity "Fabrikam Project" - - This example remove the retention event type name Fabrikam Project - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Remove-ComplianceRetentionEventType - - - - - - Remove-ComplianceTag - Remove - ComplianceTag - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-ComplianceTag - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the label. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the label. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ComplianceTag -Identity "HR Content" - - This example removes the label named HR Content. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-compliancetag - - - - - - Remove-DeviceConditionalAccessPolicy - Remove - DeviceConditionalAccessPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DeviceConditionalAccessPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DeviceConditionalAccessPolicy -Identity "Human Resources" - - This example removes the mobile device conditional access policy named Human Resources. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccesspolicy - - - - - - Remove-DeviceConditionalAccessRule - Remove - DeviceConditionalAccessRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DeviceConditionalAccessRule - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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}`. You can find the name value by running the command: Get-DeviceConditionalAccessRule | Format-List Name. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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}. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccessrule - - - - - - Remove-DeviceConfigurationPolicy - Remove - DeviceConfigurationPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DeviceConfigurationPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DeviceConfigurationPolicy -Identity "Engineering Group" - - This example removes the mobile device configuration policy named Engineering Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-deviceconfigurationpolicy - - - - - - Remove-DeviceConfigurationRule - Remove - DeviceConfigurationRule - - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DeviceConfigurationRule - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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}`. You can find the name values by running the command: Get-DeviceConfigurationRule | Format-List Name. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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}. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-deviceconfigurationrule - - - - - - Remove-DeviceTenantPolicy - Remove - DeviceTenantPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DeviceTenantPolicy - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DeviceTenantPolicy - - This example removes your organization's mobile device tenant policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-devicetenantpolicy - - - - - - Remove-DeviceTenantRule - Remove - DeviceTenantRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DeviceTenantRule - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DeviceTenantRule - - This example removes the mobile device tenant rule from your organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-devicetenantrule - - - - - - Remove-DlpCompliancePolicy - Remove - DlpCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DlpCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-dlpcompliancepolicy - - - - - - Remove-DlpComplianceRule - Remove - DlpComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DlpComplianceRule - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DlpComplianceRule -Identity "PII SS# Custom" - - This example removes the DLP rule named "PII SS# Custom". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-dlpcompliancerule - - - - - - Remove-DlpEdmSchema - Remove - DlpEdmSchema - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-DlpEdmSchema cmdlet to remove exact data match (EDM) data loss prevention (DLP) schemas from the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DlpEdmSchema - - 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) - - EdmStorageIdParameter - - EdmStorageIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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) - - EdmStorageIdParameter - - EdmStorageIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DlpEdmSchema -Identity "Schema for Patient Records" - - This example removes the DLP EDM schema named Schema for Patient Records. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Remove-DlpEdmSchema - - - Create custom sensitive information types with Exact Data Match based classification - https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification - - - - - - Remove-DlpKeywordDictionary - Remove - DlpKeywordDictionary - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DlpKeywordDictionary - - 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. - - SensitiveInformationTypeIdParameter - - SensitiveInformationTypeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - SensitiveInformationTypeIdParameter - - SensitiveInformationTypeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DlpKeywordDictionary -Identity "Financial Data" - - This example removes the DLP keyword dictionary named Financial Data. - - - - -------------------------- Example 2 -------------------------- - Get-DlpKeywordDictionary | Foreach-Object { Remove-DlpKeywordDictionary -Identity $_.Name -confirm:$True } - - This example removes all the DLP keyword dictionaries with a Confirm on each removal. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-dlpkeyworddictionary - - - - - - Remove-DlpPolicy - Remove - DlpPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-DlpPolicy - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DlpPolicy "Contoso PII" - - This example removes the existing DLP policy named Contoso PII. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-dlppolicy - - - - - - Remove-DlpSensitiveInformationType - Remove - DlpSensitiveInformationType - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-DlpSensitiveInformationType cmdlet to remove sensitive information type rules that use document fingerprints. You can't use this cmdlet to remove built-in sensitive information type rules. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center 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. - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DlpSensitiveInformationType - - 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 - - DataClassificationIdParameter - - DataClassificationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - DataClassificationIdParameter - - DataClassificationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-DlpSensitiveInformationType "Contoso Confidential" - - This example removes the sensitive information type rule named "Contoso Confidential". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype - - - - - - Remove-DlpSensitiveInformationTypeRulePackage - Remove - DlpSensitiveInformationTypeRulePackage - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-DlpSensitiveInformationTypeRulePackage - - 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) - - SensitiveInformationTypeRuleCollectionIdParameter - - SensitiveInformationTypeRuleCollectionIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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) - - SensitiveInformationTypeRuleCollectionIdParameter - - SensitiveInformationTypeRuleCollectionIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage - - - - - - Remove-HoldCompliancePolicy - Remove - HoldCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-HoldCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-HoldCompliancePolicy -Identity "Regulation 123 Compliance" - - This example removes the preservation policy named "Regulation 123 Compliance". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-holdcompliancepolicy - - - - - - Remove-HoldComplianceRule - Remove - HoldComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-HoldComplianceRule - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-HoldComplianceRule -Identity "One Year Standard" - - This example removes the preservation rule named "One Year Standard". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-holdcompliancerule - - - - - - Remove-HostedContentFilterPolicy - Remove - HostedContentFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-HostedContentFilterPolicy - - 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 - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-HostedContentFilterPolicy "Contoso Content Filter Policy" - - This example removes the spam filter policy named Contoso Content Filter Policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterpolicy - - - - - - Remove-HostedContentFilterRule - Remove - HostedContentFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-HostedContentFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-Rule "Contoso Recipients" - - This example removes the spam filter rule named Contoso Recipients. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterrule - - - - - - Remove-HostedOutboundSpamFilterPolicy - Remove - HostedOutboundSpamFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-HostedOutboundSpamFilterPolicy - - 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 - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - 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 - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-HostedOutboundSpamFilterPolicy -Identity "Contoso Executives" - - This example removes the outbound spam filter policy named Contoso Executives. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterpolicy - - - - - - Remove-HostedOutboundSpamFilterRule - Remove - HostedOutboundSpamFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-HostedOutboundSpamFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-HostedOutboundSpamFilterRule -Identity "Contoso Executives" - - This example removes the outbound spam filter rule named Contoso Executives. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterrule - - - - - - Remove-InboundConnector - Remove - InboundConnector - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Inbound connectors accept email messages from remote domains that require specific configuration options. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-InboundConnector - - Identity - - The Identity parameter specifies the Inbound connector you want to remove. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the Inbound connector you want to remove. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-InboundConnector "Contoso Inbound Connector" - - This example deletes the Inbound connector named Contoso Inbound Connector. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-inboundconnector - - - - - - Remove-InboxRule - Remove - InboxRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-InboxRule - - 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`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - AlwaysDeleteOutlookRulesBlob - - The AlwaysDeleteOutlookRulesBlob switch hides a warning message when end users or administrators use Outlook on the web or PowerShell to modify Inbox rules. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - AlwaysDeleteOutlookRulesBlob - - The AlwaysDeleteOutlookRulesBlob switch hides a warning message when end users or administrators use Outlook on the web or PowerShell to modify Inbox rules. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-inboxrule - - - - - - Remove-InformationBarrierPolicy - Remove - InformationBarrierPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-InformationBarrierPolicy cmdlet to remove information barrier policies from the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For more information, see Information barrier policies (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-InformationBarrierPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-InformationBarrierPolicy -Identity HR-Sales - - This example removes the information barrier policy named HR-Sales. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-informationbarrierpolicy - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - New-InformationBarrierPolicy - https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy - - - - - - Remove-Label - Remove - Label - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-Label cmdlet to remove sensitivity labels from your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-Label - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-Label -Identity "Marketing Group" - - This example removes the sensitivity label named Marketing Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-label - - - - - - Remove-LabelPolicy - Remove - LabelPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-LabelPolicies cmdlet to remove sensitivity label policies from your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-LabelPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-LabelPolicy -Identity "Marketing Group" - - This example removes the policy named Marketing Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-labelpolicy - - - - - - Remove-MalwareFilterPolicy - Remove - MalwareFilterPolicy - - This cmdlet is available in 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-MalwareFilterPolicy cmdlet to remove malware filter policies from your 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-MalwareFilterRule cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MalwareFilterPolicy - - Identity - - The Identity parameter specifies the malware filter policy you want to remove. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy. - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the malware filter policy you want to remove. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy. - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MalwareFilterPolicy "Contoso Malware Filter Policy" - - This example removes the malware filter policy named Contoso Malware Filter Policy - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-malwarefilterpolicy - - - - - - Remove-MalwareFilterRule - Remove - MalwareFilterRule - - This cmdlet is available in 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-MalwareFilterRule cmdlet to remove malware filter rules from your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-MalwareFilterRule - - Identity - - The Identity parameter specifies the malware filter rule that you want to remove. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the malware filter rule that you want to remove. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-MalwareFilterRule "Contoso Recipients" - - This example removes the malware filter rule named Contoso Recipients. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-malwarefilterrule - - - - - - Remove-OutboundConnector - Remove - OutboundConnector - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Outbound connectors send email messages to remote domains that require specific configuration options. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-OutboundConnector - - Identity - - The Identity parameter specifies the connector you want to remove. - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the connector you want to remove. - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-OutboundConnector "Contoso Outbound Connector" - - This example deletes the Outbound connector named Contoso Outbound Connector. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-outboundconnector - - - - - - Remove-PolicyTipConfig - Remove - PolicyTipConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-PolicyTipConfig - - Identity - - The Identity parameter specifies the custom Policy Tip you want to remove. You can use any value that uniquely identifies the custom Policy Tip. For example: - - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - - GUID - - Distinguished name (DN) - - PolicyTipConfigIdParameter - - PolicyTipConfigIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the custom Policy Tip you want to remove. You can use any value that uniquely identifies the custom Policy Tip. For example: - - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - - GUID - - Distinguished name (DN) - - PolicyTipConfigIdParameter - - PolicyTipConfigIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-policytipconfig - - - - - - Remove-ProtectionAlert - Remove - ProtectionAlert - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-ProtectionAlert - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the alert policy. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the alert policy. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-ProtectionAlert -Identity "External User File Activities" - - This example removes the alert policy named External User File Activities. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-protectionalert - - - - - - Remove-RecordLabel - Remove - RecordLabel - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-RecordLabel cmdlet to remove record labels from your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-RecordLabel - - ItemUrl - - {{ Fill ItemUrl Description }} - - String - - String - - - None - - - LabelName - - {{ Fill LabelName Description }} - - String - - String - - - None - - - - - - ItemUrl - - {{ Fill ItemUrl Description }} - - String - - String - - - None - - - LabelName - - {{ Fill LabelName Description }} - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - {{ Add example code here }} - - {{ Add example description here }} - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-recordlabel - - - - - - Remove-RetentionCompliancePolicy - Remove - RetentionCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-RetentionCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the retention policy. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the retention policy. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" - - This example removes the retention policy named "Regulation 123 Compliance". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancepolicy - - - - - - Remove-RetentionComplianceRule - Remove - RetentionComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-RetentionComplianceRule - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the retention rule. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the retention rule. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-RetentionComplianceRule -Identity "One Year Standard" - - This example removes the retention rule named "One Year Standard". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancerule - - - - - - Remove-SafeAttachmentPolicy - Remove - SafeAttachmentPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-SafeAttachmentPolicy - - 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 - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-SafeAttachmentPolicy -Identity "Block Attachments Policy" - - This example removes the safe attachment policy named Block Attachments Policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-safeattachmentpolicy - - - - - - Remove-SafeAttachmentRule - Remove - SafeAttachmentRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-SafeAttachmentRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-SafeAttachmentRule -Identity "Research Department Attachment Rule" - - This examples removes the safe attachment rule named Research Department Attachment Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-safeattachmentrule - - - - - - Remove-SafeLinksPolicy - Remove - SafeLinksPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-SafeLinksPolicy - - 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 - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-SafeLinksPolicy -Identity "Engineering Department URL Policy" - - This example remove the Safe Links policy named Engineering Department URL Policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-safelinkspolicy - - - - - - Remove-SafeLinksRule - Remove - SafeLinksRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-SafeLinksRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-SafeLinksRule -Identity "Research Department URL Rule" - - This examples removes the Safe Links rule named Research Department URL Rule. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-safelinksrule - - - - - - Remove-SupervisoryReviewPolicyV2 - Remove - SupervisoryReviewPolicyV2 - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-SupervisoryReviewPolicyV2 cmdlet to remove supervisory review policies from the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-SupervisoryReviewPolicyV2 - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ForceDeletion - - The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-SupervisoryReviewPolicyV2 -Identity "EU Brokers Policy" - - This example removes the supervisory review policy named EU Brokers Policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-supervisoryreviewpolicyv2 - - - - - - Remove-SweepRule - Remove - SweepRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-SweepRule - - 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==`). - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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==`). - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-SweepRule -Identity "x2hlsdpGmUifjFgxxGIOJw==" - - This example removes the specified Sweep rule. - - - - -------------------------- Example 2 -------------------------- - Get-SweepRule -Mailbox laura@contoso.com | Remove-SweepRule - - This example removes all Sweep rules in the specified mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-sweeprule - - - - - - Remove-TenantAllowBlockListItems - Remove - TenantAllowBlockListItems - - Note : The features described in this topic are in Preview, are subject to change, and are not available in all organizations. - 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 Security & Compliance Center. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-TenantAllowBlockListItems - - Ids - - The Ids parameter specifies the entry that you want to modify. To find this value, use the Get-TenantAllowBlockListItems cmdlet and the Entry property value (a URL or a file hash). - An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. - You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - ListType - - The ListType parameter specifies the type of entry to remove. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - Ids - - The Ids parameter specifies the entry that you want to modify. To find this value, use the Get-TenantAllowBlockListItems cmdlet and the Entry property value (a URL or a file hash). - An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. - You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - ListType - - The ListType parameter specifies the type of entry to remove. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-TenantAllowBlockListItems -ListType Url -Ids "RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0l" - - This example removes the specified URL entry from the Allow/Block List. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistitems - - - - - - Remove-TransportRule - Remove - TransportRule - - This cmdlet is available in 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-TransportRule cmdlet to remove transport rules (mail flow rules) from your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - On Mailbox servers, this cmdlet removes the rule from Active Directory. On an Edge Transport server, the cmdlet removes the rule from the local Active Directory Lightweight Directory Services (AD LDS) instance. - To temporarily disable a transport rule without removing it, use the Disable-TransportRule cmdlet instead. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-TransportRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-TransportRule -Identity "Redirect messages from kim@contoso.com to legal@contoso.com" - - This example removes the rule named "Redirect messages from kim@contoso.com to legal@contoso.com". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-transportrule - - - - - - Remove-UnifiedAuditLogRetentionPolicy - Remove - UnifiedAuditLogRetentionPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Remove-UnifiedAuditLogRetentionPolicy cmdlet to delete audit log retention policies. It might take up to 30 minutes for the policy to be completely removed. For more information, see Manage audit log retention policies (https://docs.microsoft.com/microsoft-365/compliance/audit-log-retention-policies). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Remove-UnifiedAuditLogRetentionPolicy - - 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 - - Distingished name (DN) - - GUID - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - ForceDeletion - - The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - Distingished name (DN) - - GUID - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - ForceDeletion - - The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-UnifiedAuditLogRetentionPolicy -Identity "SearchQueryPerformed by app@sharepoint" - - This example deletes the audit log retention policy named "SearchQueryPerformed by app@sharepoint". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-unifiedauditlogretentionpolicy - - - - - - Rotate-DkimSigningConfig - Rotate - DkimSigningConfig - - 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 365 automatically rotates your DKIM keys. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Rotate-DkimSigningConfig - - 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 - - DkimSigningConfigIdParameter - - DkimSigningConfigIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - KeySize - - The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are 1024 or 2048. - RSA keys are supported; Ed25519 keys aren't supported. - - UInt16 - - UInt16 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - DkimSigningConfigIdParameter - - DkimSigningConfigIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - KeySize - - The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are 1024 or 2048. - RSA keys are supported; Ed25519 keys aren't supported. - - UInt16 - - UInt16 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Rotate-DkimSigningConfig -Identity contoso.com - - This example rotates the DKIM signing policy for the contoso.com domain. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/rotate-dkimsigningconfig - - - - - - Search-MessageTrackingReport - Search - MessageTrackingReport - - This cmdlet is available only in on-premises Exchange. - Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see Get-MessageTrackingReport (https://docs.microsoft.com/powershell/module/exchange/get-messagetrackingreport). The message tracking report cmdlets are used by the delivery reports feature. - In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Search-MessageTrackingReport - - Identity - - The Identity parameter scopes the search 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) - - 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. - When you use this parameter with the Sender parameter, the specified mailbox is message recipient that's used in the search. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Sender - - The Sender parameter specifies the email address of the message sender for messages that are sent to the mailbox that's specified by the Identity parameter. - You need to use this parameter with the Identity parameter. - - SmtpAddress - - SmtpAddress - - - None - - - BypassDelegateChecking - - The BypassDelegateChecking switch allows Help desk staff and administrators to track messages for any user. You don't need to specify a value with this switch. - By default, users can only track messages that they send or receive from their own mailbox. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DoNotResolve - - The DoNotResolve switch specifies whether to prevent the resolution of email addresses to display names. You don't need to specify a value with this switch. - Using this switch improves performance, but the lack of display names might make the results more difficult to interpret. - - - SwitchParameter - - - False - - - MessageEntryId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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@contoso.com>"). - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Subject - - The Subject parameter searches for messages with the specified Subject field value. If the value contains spaces, enclosed the value in quotation marks. - - String - - String - - - None - - - TraceLevel - - 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. - - TraceLevel - - TraceLevel - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Search-MessageTrackingReport - - Identity - - The Identity parameter scopes the search 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) - - 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. - When you use this parameter with the Sender parameter, the specified mailbox is message recipient that's used in the search. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - BypassDelegateChecking - - The BypassDelegateChecking switch allows Help desk staff and administrators to track messages for any user. You don't need to specify a value with this switch. - By default, users can only track messages that they send or receive from their own mailbox. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DoNotResolve - - The DoNotResolve switch specifies whether to prevent the resolution of email addresses to display names. You don't need to specify a value with this switch. - Using this switch improves performance, but the lack of display names might make the results more difficult to interpret. - - - SwitchParameter - - - False - - - MessageEntryId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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@contoso.com>"). - - String - - String - - - None - - - Recipients - - The Recipients parameter filters the results by the email addresses of the specified recipients. You can specify multiple email addresses separated by commas. - You can't use this parameter with the Sender parameter. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Subject - - The Subject parameter searches for messages with the specified Subject field value. If the value contains spaces, enclosed the value in quotation marks. - - String - - String - - - None - - - TraceLevel - - 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. - - TraceLevel - - TraceLevel - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter scopes the search 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) - - 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. - When you use this parameter with the Sender parameter, the specified mailbox is message recipient that's used in the search. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Sender - - The Sender parameter specifies the email address of the message sender for messages that are sent to the mailbox that's specified by the Identity parameter. - You need to use this parameter with the Identity parameter. - - SmtpAddress - - SmtpAddress - - - None - - - BypassDelegateChecking - - The BypassDelegateChecking switch allows Help desk staff and administrators to track messages for any user. You don't need to specify a value with this switch. - By default, users can only track messages that they send or receive from their own mailbox. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DoNotResolve - - The DoNotResolve switch specifies whether to prevent the resolution of email addresses to display names. You don't need to specify a value with this switch. - Using this switch improves performance, but the lack of display names might make the results more difficult to interpret. - - SwitchParameter - - SwitchParameter - - - False - - - MessageEntryId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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@contoso.com>"). - - String - - String - - - None - - - Recipients - - The Recipients parameter filters the results by the email addresses of the specified recipients. You can specify multiple email addresses separated by commas. - You can't use this parameter with the Sender parameter. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - Subject - - The Subject parameter searches for messages with the specified Subject field value. If the value contains spaces, enclosed the value in quotation marks. - - String - - String - - - None - - - TraceLevel - - 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. - - TraceLevel - - TraceLevel - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Search-MessageTrackingReport -Identity "Cigdem Akin" -Sender "joe@contoso.com" -BypassDelegateChecking -DoNotResolve - - This example searches the message tracking report for the following scenario: The user Cigdem Akin was expecting an email message from joe@contoso.com that never arrived. She contacted the Help desk, which needs to generate the message tracking report on behalf of Cigdem and doesn't need to see the display names. - This example returns the message tracking reports that the Help desk can analyze to resolve the issue. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/search-messagetrackingreport - - - - - - Set-ActivityAlert - Set - ActivityAlert - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-ActivityAlert - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - Condition - - The Condition parameter specifies filter conditions for event aggregation. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - EmailCulture - - The EmailCulture parameter specifies the language of the notification email message. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - Double - - Double - - - None - - - Name - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - NotifyUser - - The NotifyUser parameter specifies the email address of the recipients who will receive the notification emails. You can specify internal and external email addresses. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To modify the existing list of recipients, see the Examples section. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Operation - - The Operation parameter specifies the activities that trigger activity alerts. - A valid value for this parameter is an activity that's available in the Microsoft 365 audit log. For a description of these activities, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - For the syntax that you use to modify an existing list of Operations values, see the Examples section. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecordType - - The RecordType parameter specifies a record type label for the activity alert. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - - AuditLogRecordType - - AuditLogRecordType - - - None - - - 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 - - AlertScopeLevel - - AlertScopeLevel - - - None - - - Severity - - The Severity parameter specifies a severity level for the activity alert. Valid values are: - - None - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - UserId - - The UserId parameter specifies who you want to monitor. - - If you specify a user's email address, you'll receive an email notification when the user performs the specified activity. You can specify multiple email addresses separated by commas. - - If this parameter is blank ($null), you'll receive an email notification when any user in your organization performs the specified activity. - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - You can only use this parameter on activity alerts that have the Type property values Custom or ElevationOfPrivilege. - For the syntax that you use to modify an existing list of UserId values, see the Examples section. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - Condition - - The Condition parameter specifies filter conditions for event aggregation. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - EmailCulture - - The EmailCulture parameter specifies the language of the notification email message. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - Double - - Double - - - None - - - Name - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - NotifyUser - - The NotifyUser parameter specifies the email address of the recipients who will receive the notification emails. You can specify internal and external email addresses. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To modify the existing list of recipients, see the Examples section. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Operation - - The Operation parameter specifies the activities that trigger activity alerts. - A valid value for this parameter is an activity that's available in the Microsoft 365 audit log. For a description of these activities, see Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - For the syntax that you use to modify an existing list of Operations values, see the Examples section. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecordType - - The RecordType parameter specifies a record type label for the activity alert. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - - AuditLogRecordType - - AuditLogRecordType - - - None - - - 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 - - AlertScopeLevel - - AlertScopeLevel - - - None - - - Severity - - The Severity parameter specifies a severity level for the activity alert. Valid values are: - - None - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - UserId - - The UserId parameter specifies who you want to monitor. - - If you specify a user's email address, you'll receive an email notification when the user performs the specified activity. You can specify multiple email addresses separated by commas. - - If this parameter is blank ($null), you'll receive an email notification when any user in your organization performs the specified activity. - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - You can only use this parameter on activity alerts that have the Type property values Custom or ElevationOfPrivilege. - For the syntax that you use to modify an existing list of UserId values, see the Examples section. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-activityalert - - - - - - Set-AntiPhishPolicy - Set - AntiPhishPolicy - - This cmdlet is available only in the cloud-based service. - Use the Set-AntiPhishPolicy cmdlet to modify antiphish policies in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AntiPhishPolicy - - 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 - - AntiPhishPolicyIdParameter - - AntiPhishPolicyIdParameter - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - SpoofAuthenticationFailAction - - SpoofAuthenticationFailAction - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the antiphish policy is enabled or disabled. Valid values are: - $true: The policy is enabled. - $false: The policy is disabled. - - Boolean - - Boolean - - - None - - - EnableMailboxIntelligence - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence (artificial intelligence that determines user email patterns with their frequent contacts). Valid values are:: - - $true: Mailbox intelligence is enabled. This is the default value. - - $false: Mailbox intelligence is disabled. - - Boolean - - Boolean - - - None - - - EnableMailboxIntelligenceProtection - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The EnableMailboxIntelligenceProtection specifies whether to enable or disable enhanced impersonation results based on each user's individual sender map. This intelligence allows Microsoft 365 to customize user impersonation detection and better handle false positives. Valid values are: - - $true: Enable mailbox intelligence based impersonation protection. - - $false: Don't enable mailbox intelligence based impersonation protection. This is the default value. - - Boolean - - Boolean - - - None - - - EnableOrganizationDomainsProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableSimilarDomainsSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableSimilarUsersSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - 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. You specify the spoofed senders to allow or block using the New-TenantAllowBlockListSpoofItems cmdlet. - - $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. - - Boolean - - Boolean - - - None - - - EnableTargetedDomainsProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableTargetedUserProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - 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. The via tag (chris@contoso.com <u>via</u> fabrikam.com) is added if the domain in the From address (the message sender that's displayed in email clients) is different from the domain in the DKIM signature or the MAIL FROM address. - - $false: A question mark is never applied to the sender's photo. The via tag is still added if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. - - 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. This action will prevent the via tag from appearing in messages from the sender when unauthenticated sender identification is disabled. For instructions, see Configure spoof intelligence in Microsoft 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). - If you own the sender's domain, configure email authentication for the domain. For more information, see Configure email authentication for domains you own (https://docs.microsoft.com/microsoft-365/security/office-365-security/email-validation-and-authentication#configure-email-authentication-for-domains-you-own). - - Boolean - - Boolean - - - True - - - EnableUnusualCharactersSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - ExcludedDomains - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExcludedSenders - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ImpersonationProtectionState - - This setting is part of impersonation protection and is only available 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 - - ImpersonationProtectionState - - ImpersonationProtectionState - - - None - - - MailboxIntelligenceProtectionAction - - This setting is part of impersonation protection and is only available 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. - - BccMessage: Add the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter to the Bcc field of the message. - - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. - - ImpersonationAction - - ImpersonationAction - - - None - - - MailboxIntelligenceProtectionActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MakeDefault - - The MakeDefault switch makes the specified antiphish policy the default antiphish policy. You don't have 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). - - - SwitchParameter - - - False - - - PhishThresholdLevel - - This setting is part of advanced settings and is only available 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. - - Int32 - - Int32 - - - None - - - PolicyTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - TargetedDomainActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedDomainProtectionAction - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: - - NoAction: This is the default value. - - BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedDomainsToProtect - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUserActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUserProtectionAction - - This setting is part of impersonation protection and is only available 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. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUsersToProtect - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - AntiPhishPolicyIdParameter - - AntiPhishPolicyIdParameter - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - SpoofAuthenticationFailAction - - SpoofAuthenticationFailAction - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the antiphish policy is enabled or disabled. Valid values are: - $true: The policy is enabled. - $false: The policy is disabled. - - Boolean - - Boolean - - - None - - - EnableMailboxIntelligence - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence (artificial intelligence that determines user email patterns with their frequent contacts). Valid values are:: - - $true: Mailbox intelligence is enabled. This is the default value. - - $false: Mailbox intelligence is disabled. - - Boolean - - Boolean - - - None - - - EnableMailboxIntelligenceProtection - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The EnableMailboxIntelligenceProtection specifies whether to enable or disable enhanced impersonation results based on each user's individual sender map. This intelligence allows Microsoft 365 to customize user impersonation detection and better handle false positives. Valid values are: - - $true: Enable mailbox intelligence based impersonation protection. - - $false: Don't enable mailbox intelligence based impersonation protection. This is the default value. - - Boolean - - Boolean - - - None - - - EnableOrganizationDomainsProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableSimilarDomainsSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableSimilarUsersSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - 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. You specify the spoofed senders to allow or block using the New-TenantAllowBlockListSpoofItems cmdlet. - - $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. - - Boolean - - Boolean - - - None - - - EnableTargetedDomainsProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - EnableTargetedUserProtection - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - 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. The via tag (chris@contoso.com <u>via</u> fabrikam.com) is added if the domain in the From address (the message sender that's displayed in email clients) is different from the domain in the DKIM signature or the MAIL FROM address. - - $false: A question mark is never applied to the sender's photo. The via tag is still added if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. - - 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. This action will prevent the via tag from appearing in messages from the sender when unauthenticated sender identification is disabled. For instructions, see Configure spoof intelligence in Microsoft 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). - If you own the sender's domain, configure email authentication for the domain. For more information, see Configure email authentication for domains you own (https://docs.microsoft.com/microsoft-365/security/office-365-security/email-validation-and-authentication#configure-email-authentication-for-domains-you-own). - - Boolean - - Boolean - - - True - - - EnableUnusualCharactersSafetyTips - - This setting is part of impersonation protection and is only available 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. - - Boolean - - Boolean - - - None - - - ExcludedDomains - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExcludedSenders - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ImpersonationProtectionState - - This setting is part of impersonation protection and is only available 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 - - ImpersonationProtectionState - - ImpersonationProtectionState - - - None - - - MailboxIntelligenceProtectionAction - - This setting is part of impersonation protection and is only available 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. - - BccMessage: Add the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter to the Bcc field of the message. - - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. - - ImpersonationAction - - ImpersonationAction - - - None - - - MailboxIntelligenceProtectionActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MakeDefault - - The MakeDefault switch makes the specified antiphish policy the default antiphish policy. You don't have 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). - - SwitchParameter - - SwitchParameter - - - False - - - PhishThresholdLevel - - This setting is part of advanced settings and is only available 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. - - Int32 - - Int32 - - - None - - - PolicyTag - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - TargetedDomainActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedDomainProtectionAction - - This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. - The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: - - NoAction: This is the default value. - - BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedDomainsToProtect - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUserActionRecipients - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUserProtectionAction - - This setting is part of impersonation protection and is only available 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. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. - - Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - TargetedUsersToProtect - - This setting is part of impersonation protection and is only available 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-antiphishpolicy - - - - - - Set-AntiPhishRule - Set - AntiPhishRule - - This cmdlet is available only in the cloud-based service. - Use the Set-AntiPhishRule cmdlet to modify antiphish rules in your cloud-based organization. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AntiPhishRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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 - - AntiPhishPolicyIdParameter - - AntiPhishPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - Name - - The Name parameter specifies a unique name for the antiphish rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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 - - AntiPhishPolicyIdParameter - - AntiPhishPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - Name - - The Name parameter specifies a unique name for the antiphish rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-antiphishrule - - - - - - Set-AtpPolicyForO365 - Set - AtpPolicyForO365 - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see Safe Links settings for Office 365 apps (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#safe-links-settings-for-office-365-apps). - Safe Documents scans documents and files that are opened in Protected View. For more information, see Safe Documents in Microsoft 365 E5 (https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-docs). - Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see Safe Attachments for SharePoint, OneDrive, and Microsoft Teams (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-AtpPolicyForO365 - - Identity - - The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. - - AtpPolicyForO365IdParameter - - AtpPolicyForO365IdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BlockUrls - - The BlockUrls parameter specifies the URLs that are always blocked by Safe Links in email messages and Safe Links for Office 365 apps. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - For details about the entry syntax, see Entry syntax for the "Block the following URLs" list (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-block-the-following-urls-list). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - EnableATPForSPOTeamsODB - - The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. Valid values are: - - $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint Online admins can use the DisallowInfectedFileDownload parameter on the Set-SPOTenant (https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant)cmdlet to control whether users are allowed to download files that are found to be malicious. - $false: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is disabled. This is the default value. - - Boolean - - Boolean - - - None - - - EnableSafeDocs - - The EnableSafeDocs parameter enables or disables Safe Documents in Microsoft 365 E5 or Microsoft 365 E5 Security organizations. 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. - - AtpPolicyForO365IdParameter - - AtpPolicyForO365IdParameter - - - None - - - AllowClickThrough - - The AllowClickThrough parameter specifies whether to allow users to click through to the original blocked URL in Safe Links protection for Office apps. Valid values are: - - $true: Users are allowed to click through to the original URL in supported Office apps. - - $false: Users aren't allowed to click through to the original URL in supported Office apps. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BlockUrls - - The BlockUrls parameter specifies the URLs that are always blocked by Safe Links in email messages and Safe Links for Office 365 apps. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - For details about the entry syntax, see Entry syntax for the "Block the following URLs" list (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-block-the-following-urls-list). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - EnableATPForSPOTeamsODB - - The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. Valid values are: - - $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint Online admins can use the DisallowInfectedFileDownload parameter on the Set-SPOTenant (https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant)cmdlet to control whether users are allowed to download files that are found to be malicious. - $false: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is disabled. This is the default value. - - Boolean - - Boolean - - - None - - - EnableSafeDocs - - The EnableSafeDocs parameter enables or disables Safe Documents in Microsoft 365 E5 or Microsoft 365 E5 Security organizations. 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. - - Boolean - - Boolean - - - None - - - EnableSafeLinksForO365Clients - - The EnableSafeLinksForO365Clients parameter enables or disables Safe Links for Office 365 apps. Valid values are: - - $true: Safe Links scanning is enabled in supported Office 365 apps. This is the default value. - - $false: Safe Links scanning is disabled in supported Office 365 apps. - - Note that this protection applies to links in Office documents, not links in email messages. Safe Links protection for links in email messages is controlled by Safe Links policies (the New-SafeLinksPolicy (https://docs.microsoft.com/powershell/module/exchange/new-safelinkspolicy) or [Set-SafeLinksPolicy](https://docs.microsoft.com/powershell/module/exchange/set-safelinkspolicy) cmdlets). - - Boolean - - Boolean - - - None - - - TrackClicks - - The TrackClicks parameter specifies whether to track user clicks related to blocked URLs in Safe Links for Office 365 apps. Valid values are: - - $true: User clicks in supported Office 365 apps are tracked. - - $false: User clicks in supported Office 365 apps aren't tracked. This is the default value. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-AtpPolicyForO365 -EnableATPForSPOTeamsODB $true - - This example enables Safe Documents and Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-atppolicyforo365 - - - - - - Set-AuditConfig - Set - AuditConfig - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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 365. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-AuditConfig - - Identity - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Workload - - The Workload parameter specifies where auditing is allowed. Valid values are: - - Exchange - - InTune - - OneDriveForBusiness - - SharePoint - - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - Organization - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - Identity - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Workload - - The Workload parameter specifies where auditing is allowed. Valid values are: - - Exchange - - InTune - - OneDriveForBusiness - - SharePoint - - You can specify multiple values separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - Organization - - This parameter is reserved for internal Microsoft use. - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-AuditConfig -Workload Exchange,SharePoint - - This example sets the auditing configuration for Exchange and SharePoint. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-auditconfig - - - - - - Set-AuditConfigurationRule - Set - AuditConfigurationRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-AuditConfigurationRule - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-auditconfigurationrule - - - - - - Set-AutoSensitivityLabelPolicy - Set - AutoSensitivityLabelPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-AutoSensitivityLabelPolicy cmdlet to modify auto-labeling policies in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-AutoSensitivityLabelPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - AddExchangeLocation - - This AddExchangeLocation parameter specifies new Exchange locations to be added to the policy without affecting the existing ones. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddOneDriveLocationException - - The AddOneDriveLocationException parameter specifies the OneDrive for Business sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddSharePointLocationException - - The AddSharePointLocationException parameter specifies the SharePoint Online sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. - 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>". }} - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ApplySensitivityLabel - - The ApplySensitivityLabel parameter selects which label to be used for the policy. This will override the previous label on the policy. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - ExchangeSender - - The ExchangeSender parameter specifies the sender list in Exchange for which the policy should include. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderException - - The ExchangeSenderException parameter specifies the sender list in Exchange for which the policy should exclude. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOf - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the autolabeling policy. You identify the group by its email address. - To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOfException - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the autolabeling policy. You identify the group by its email address. - To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - - SwitchParameter - - - False - - - Mode - - The Mode parameter specifies the action and notification level of the autolabel 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). - - - Enable - TestWithNotifications - TestWithoutNotifications - Disable - PendingDeletion - - PolicyMode - - PolicyMode - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - RemoveExchangeLocation - - The RemoveExchangeLocation parameter removes locations on Exchange from the policy. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveOneDriveLocationException - - This RemoveOneDriveLocationException parameter specifies the OneDrive for Business sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveSharePointLocationException - - The RemoveSharePointLocationException parameter specifies the SharePoint Online sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-AutoSensitivityLabelPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - Mode - - The Mode parameter specifies the action and notification level of the autolabel 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). - - - Enable - TestWithNotifications - TestWithoutNotifications - Disable - PendingDeletion - - PolicyMode - - PolicyMode - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-AutoSensitivityLabelPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Mode - - The Mode parameter specifies the action and notification level of the autolabel 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). - - - Enable - TestWithNotifications - TestWithoutNotifications - Disable - PendingDeletion - - PolicyMode - - PolicyMode - - - None - - - RetryDistribution - - The RetryDistribution switch redistributes the policy to all OneDrive for Business and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - AddExchangeLocation - - This AddExchangeLocation parameter specifies new Exchange locations to be added to the policy without affecting the existing ones. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddOneDriveLocationException - - The AddOneDriveLocationException parameter specifies the OneDrive for Business sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddSharePointLocationException - - The AddSharePointLocationException parameter specifies the SharePoint Online sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. - 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>". }} - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ApplySensitivityLabel - - The ApplySensitivityLabel parameter selects which label to be used for the policy. This will override the previous label on the policy. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - ExchangeSender - - The ExchangeSender parameter specifies the sender list in Exchange for which the policy should include. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderException - - The ExchangeSenderException parameter specifies the sender list in Exchange for which the policy should exclude. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOf - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the autolabeling policy. You identify the group by its email address. - To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOfException - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the autolabeling policy. You identify the group by its email address. - To enter multiple values, use the following syntax: <value1>,<value2>,...<valueX>. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Mode - - The Mode parameter specifies the action and notification level of the autolabel 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). - - PolicyMode - - PolicyMode - - - None - - - 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. - - System.Int32 - - System.Int32 - - - None - - - RemoveExchangeLocation - - The RemoveExchangeLocation parameter removes locations on Exchange from the policy. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveOneDriveLocationException - - This RemoveOneDriveLocationException parameter specifies the OneDrive for Business sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveSharePointLocationException - - The RemoveSharePointLocationException parameter specifies the SharePoint Online sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. - 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>". - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RetryDistribution - - The RetryDistribution switch redistributes the policy to all OneDrive for Business and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-AutoSensitivityLabelPolicy -Identity "Main PII" -AddSharePointLocation "https://my.url1","https://my.url2" -AddOneDriveLocation "https://my.url3","https://my.url4" - - This example adds the specified URLs to the SharePoint Online and OneDrive for Business locations for the autolabeling policy named Main PII without affecting the existing URL values. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-autosensitivitylabelpolicy - - - - - - Set-AutoSensitivityLabelRule - Set - AutoSensitivityLabelRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-AutoSensitivityLabelPolicy cmdlet to modify auto-labeling policy rules in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-AutoSensitivityLabelRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - - InOrganization - NotInOrganization - None - - AccessScope - - AccessScope - - - None - - - ActivationDate - - {{ Fill ActivationDate Description }} - - System.DateTime - - System.DateTime - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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"})`. - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DocumentIsPasswordProtected - - The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - InOrganization - NotInOrganization - None - - AccessScope - - AccessScope - - - None - - - 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"}). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentIsPasswordProtected - - The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExceptIfProcessingLimitExceeded - - The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule 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. - - Boolean - - Boolean - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSenderIPRanges - - The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExpiryDate - - This parameter is reserved for internal Microsoft use. - - System.DateTime - - System.DateTime - - - None - - - From - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - FromMemberOf - - This parameter is reserved for internal Microsoft use. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - Priority - - This parameter is reserved for internal Microsoft use. - - System.Int32 - - System.Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - - Low - Medium - High - None - Informational - Information - - RuleSeverity - - RuleSeverity - - - None - - - RuleErrorAction - - The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: - - Ignore - - RetryThenBlock - - Blank (the value $null): This is the default value. - - - Ignore - RetryThenBlock - - PolicyRuleErrorAction - - PolicyRuleErrorAction - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - Workload - - The Workload parameter specifies the workload. Valid values are: - - Exchange - - OneDriveForBusiness - - SharePoint - - - Exchange - SharePoint - OneDriveForBusiness - - Workload - - Workload - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - AccessScope - - AccessScope - - - None - - - ActivationDate - - {{ Fill ActivationDate Description }} - - System.DateTime - - System.DateTime - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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"})`. - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DocumentIsPasswordProtected - - The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - AccessScope - - AccessScope - - - None - - - 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"}). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentIsPasswordProtected - - The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExceptIfProcessingLimitExceeded - - The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule 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. - - Boolean - - Boolean - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSenderIPRanges - - The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExpiryDate - - This parameter is reserved for internal Microsoft use. - - System.DateTime - - System.DateTime - - - None - - - From - - This parameter is reserved for internal Microsoft use. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - FromMemberOf - - This parameter is reserved for internal Microsoft use. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - Priority - - This parameter is reserved for internal Microsoft use. - - System.Int32 - - System.Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - PolicyRuleErrorAction - - PolicyRuleErrorAction - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - Workload - - The Workload parameter specifies the workload. Valid values are: - - Exchange - - OneDriveForBusiness - - SharePoint - - Workload - - Workload - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-AutoSensitivityLabelRule -Identity "SocialSecurityRule1" -Comment "Example" - - This example changes the rule property "Comment" with the rule name "SocialSecurityRule1" to the text "Example". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-autosensitivitylabelrule - - - - - - Set-CaseHoldPolicy - Set - CaseHoldPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-CaseHoldPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-CaseHoldPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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 - - Azure AD ObjectId (You can use the Get-AzureADUser (https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - Azure AD ObjectId (You can use the Get-AzureADUser (https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 Online site `https://contoso.sharepoint.com/sites/teams/finance`. - - Removes public folders. - - Updates the comment. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-caseholdpolicy - - - - - - Set-CaseHoldRule - Set - CaseHoldRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-CaseHoldRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-CaseHoldRule -Identity "Internal Company Rule" -Disabled $true - - This example disables the enabled case hold rule named "Internal Company Rule". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-caseholdrule - - - - - - Set-ComplianceRetentionEventType - Set - ComplianceRetentionEventType - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ComplianceRetentionEventType - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Set-ComplianceRetentionEventType - - - - - - Set-ComplianceTag - Set - ComplianceTag - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-ComplianceTag - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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="ReferenceA"},@{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. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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". - - String - - String - - - None - - - RetentionDuration - - The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - - A positive integer. - - The value unlimited. - - Unlimited - - Unlimited - - - None - - - 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. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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="ReferenceA"},@{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. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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". - - String - - String - - - None - - - RetentionDuration - - The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - - A positive integer. - - The value unlimited. - - Unlimited - - Unlimited - - - None - - - 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. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-compliancetag - - - - - - Set-DeviceConditionalAccessPolicy - Set - DeviceConditionalAccessPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DeviceConditionalAccessPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-DeviceConditionalAccessPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-DeviceConditionalAccessPolicy -Identity Executives -Enabled $false - - This example disables the existing mobile device conditional access policy named Executives. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-deviceconditionalaccesspolicy - - - - - - Set-DeviceConditionalAccessRule - Set - DeviceConditionalAccessRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DeviceConditionalAccessRule - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - CARatingAppsEntry - - CARatingAppsEntry - - - None - - - 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. - - CAAutoUpdateStatusEntry - - CAAutoUpdateStatusEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Required - - Required - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - CARatingMovieEntry - - CARatingMovieEntry - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - CARatingRegionEntry - - CARatingRegionEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - CARatingTvShowEntry - - CARatingTvShowEntry - - - None - - - 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. - - CAUserAccountControlStatusEntry - - CAUserAccountControlStatusEntry - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - - - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - CARatingAppsEntry - - CARatingAppsEntry - - - None - - - 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. - - CAAutoUpdateStatusEntry - - CAAutoUpdateStatusEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Required - - Required - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - CARatingMovieEntry - - CARatingMovieEntry - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - CARatingRegionEntry - - CARatingRegionEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - CARatingTvShowEntry - - CARatingTvShowEntry - - - None - - - 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. - - CAUserAccountControlStatusEntry - - CAUserAccountControlStatusEntry - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-deviceconditionalaccessrule - - - - - - Set-DeviceConfigurationPolicy - Set - DeviceConfigurationPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DeviceConfigurationPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-DeviceConfigurationPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-DeviceConfigurationPolicy -Identity "Engineering Group" -Enabled $false - - This example disables the mobile device configuration policy named Engineering Group. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-deviceconfigurationpolicy - - - - - - Set-DeviceConfigurationRule - Set - DeviceConfigurationRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DeviceConfigurationRule - - 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}`. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - RatingAppsEntry - - RatingAppsEntry - - - None - - - 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. - - AutoUpdateStatusEntry - - AutoUpdateStatusEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Required - - Required - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - RatingMovieEntry - - RatingMovieEntry - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - RatingRegionEntry - - RatingRegionEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - RatingTvShowEntry - - RatingTvShowEntry - - - None - - - 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. - - UserAccountControlStatusEntry - - UserAccountControlStatusEntry - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - - - - 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}`. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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. - - RatingAppsEntry - - RatingAppsEntry - - - None - - - 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. - - AutoUpdateStatusEntry - - AutoUpdateStatusEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Required - - Required - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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. - - RatingMovieEntry - - RatingMovieEntry - - - None - - - 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. - - Int64 - - Int64 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - TimeSpan - - TimeSpan - - - None - - - 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+ - - Boolean - - Boolean - - - None - - - 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. - - RatingRegionEntry - - RatingRegionEntry - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - RatingTvShowEntry - - RatingTvShowEntry - - - None - - - 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. - - UserAccountControlStatusEntry - - UserAccountControlStatusEntry - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-deviceconfigurationrule - - - - - - Set-DeviceTenantPolicy - Set - DeviceTenantPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DeviceTenantPolicy - - RetryDistribution - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-DeviceTenantPolicy - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - RetryDistribution - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-DeviceTenantPolicy -Enabled $false - - This example disables your organization's mobile device tenant policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-devicetenantpolicy - - - - - - Set-DeviceTenantRule - Set - DeviceTenantRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 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 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DeviceTenantRule - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - ApplyPolicyTo - - The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - - ExchangeOnline - - SharePointOnline - - ExchangeAndSharePoint - - PolicyResourceScope - - PolicyResourceScope - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - ApplyPolicyTo - - The ApplyPolicyTo parameter specifies where to apply the policy in your organization. Valid values for this parameter are: - - ExchangeOnline - - SharePointOnline - - ExchangeAndSharePoint - - PolicyResourceScope - - PolicyResourceScope - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-devicetenantrule - - - - - - Set-DkimSigningConfig - Set - DkimSigningConfig - - This cmdlet is available only in the cloud-based service. - Use the Set-DkimSigningConfig cmdlet to modify the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-DkimSigningConfig - - Identity - - 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 - - DkimSigningConfigIdParameter - - DkimSigningConfigIdParameter - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - BodyCanonicalization - - 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. - - CanonicalizationType - - CanonicalizationType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - HeaderCanonicalization - - 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. - - CanonicalizationType - - CanonicalizationType - - - None - - - PublishTxtRecords - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - DkimSigningConfigIdParameter - - DkimSigningConfigIdParameter - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - BodyCanonicalization - - 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. - - CanonicalizationType - - CanonicalizationType - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - HeaderCanonicalization - - 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. - - CanonicalizationType - - CanonicalizationType - - - None - - - PublishTxtRecords - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-DkimSigningConfig -Identity contoso.com -Enabled $false - - This example disables the DKIM signing policy for the contoso.com domain. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-dkimsigningconfig - - - - - - Set-DlpCompliancePolicy - Set - DlpCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DlpCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - The RetryDistribution switch redistributes the policy to all OneDrive for Business and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-DlpCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - AddEndpointDlpLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddEndpointDlpLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddExchangeLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddTeamsLocation - - The AddTeamsLocation parameter specifies the Teams accounts to add to the list of included accounts when you aren't using the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddTeamsLocationException - - The AddTeamsLocationException parameter specifies the Teams accounts to add to the list of excluded accounts when you use the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ExchangeSenderMemberOf - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the DLP policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOfException - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the DLP policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - - SwitchParameter - - - 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. - - PolicyMode - - PolicyMode - - - None - - - 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. - - Int32 - - Int32 - - - None - - - RemoveEndpointDlpLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveEndpointDlpLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveExchangeLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveTeamsLocation - - The RemoveTeamsLocation parameter specifies the Teams accounts to remove from the list of included accounts when you use the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveTeamsLocationException - - The RemoveTeamsLocation parameter specifies the Teams accounts to remove from the list of excluded accounts when you aren't using the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - The RetryDistribution switch redistributes the policy to all OneDrive for Business and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - SwitchParameter - - SwitchParameter - - - False - - - AddEndpointDlpLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddEndpointDlpLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddExchangeLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddTeamsLocation - - The AddTeamsLocation parameter specifies the Teams accounts to add to the list of included accounts when you aren't using the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddTeamsLocationException - - The AddTeamsLocationException parameter specifies the Teams accounts to add to the list of excluded accounts when you use the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ExchangeSenderMemberOf - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the DLP policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - ExchangeSenderMemberOfException - - The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the DLP policy. You identify the group by its email address. - You can enter multiple values separated by commas. - You can't use this parameter to specify Microsoft 365 Groups. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - PolicyMode - - PolicyMode - - - None - - - 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. - - Int32 - - Int32 - - - None - - - RemoveEndpointDlpLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveEndpointDlpLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveExchangeLocation - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveTeamsLocation - - The RemoveTeamsLocation parameter specifies the Teams accounts to remove from the list of included accounts when you use the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveTeamsLocationException - - The RemoveTeamsLocation parameter specifies the Teams accounts to remove from the list of excluded accounts when you aren't using the value All for the TeamsLocation parameter. You identify the account by its name or 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-dlpcompliancepolicy - - - - - - Set-DlpComplianceRule - Set - DlpComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DlpComplianceRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - AccessScope - - AccessScope - - - None - - - ActivationDate - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - 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: - - `@{<AddToRecipients | CopyTo | BlindCopyTo> = "emailaddress"}`. For example, `@{AddToRecipients = "laura@contoso.com"}` or `@{BlindCopyTo = "julia@contoso.com"}`. - - `@{AddManagerAsRecipientType = "<To | Cc | Bcc>"}`. For example, `@{AddManagerAsRecipientType = "Bcc"}`. - - You can use this action in DLP policies that are scoped only to Exchange. - - PswsHashtable - - PswsHashtable - - - None - - - 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 50. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 = <Append | Prepend>; FallbackAction = <Wrap | Ignore | Reject> }`. - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BlockAccessScope - - The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - - All: Block access to everyone except the owner and the last modifier. - - PerUser: Block access to external users. - - PerAnonymousUser: Block access to people through the "Anyone with the link" option in SharePoint and OneDrive. - - BlockAccessScope - - BlockAccessScope - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - ContentExtensionMatchesWords - - The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - DocumentIsPasswordProtected - - The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - $true | $false - - $true | $false - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - DocumentNameMatchesPatterns - - The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule 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"`. - The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DocumentNameMatchesWords - - The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the file 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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 inside the organization. - - NotInOrganization: The rule isn't applied to content that's accessible outside the organization. - - None: The exception isn't used. - - AccessScope - - AccessScope - - - None - - - 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 50. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. - Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see What the sensitive information types in Exchange look for (https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - ExceptIfContentExtensionMatchesWords - - The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentIsPasswordProtected - - The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfDocumentNameMatchesPatterns - - The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule 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"`. - The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentNameMatchesWords - - The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the file 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - FromScope - - FromScope - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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: Encrypted messages. - - PermissionControlled: Messages that have specific permissions configured. - - ReadReceipt: Read receipts. - - Signed: Digitally signed messages. - - You can use this exception in DLP policies that are scoped only to Exchange. - - MessageTypes - - MessageTypes - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - WithImportance - - WithImportance - - - None - - - ExpiryDate - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - FromMemberOf - - This parameter is reserved for internal Microsoft use. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - FromScope - - The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: - - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - - 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. - - FromScope - - FromScope - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - ReportContentOption[] - - ReportContentOption[] - - - None - - - 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: Encrypted messages. - - PermissionControlled: Messages that have specific permissions configured. - - ReadReceipt: Read receipts. - - Signed: Digitally signed messages. - - You can use this condition in DLP policies that are scoped only to Exchange. - - MessageTypes - - MessageTypes - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - OverrideOption[] - - OverrideOption[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - NotifyPolicyTipCustomTextTranslations - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - PrependSubject - - The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - PolicyRuleErrorAction - - PolicyRuleErrorAction - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - 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. - - WithImportance - - WithImportance - - - None - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - AccessScope - - AccessScope - - - None - - - ActivationDate - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - 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: - - `@{<AddToRecipients | CopyTo | BlindCopyTo> = "emailaddress"}`. For example, `@{AddToRecipients = "laura@contoso.com"}` or `@{BlindCopyTo = "julia@contoso.com"}`. - - `@{AddManagerAsRecipientType = "<To | Cc | Bcc>"}`. For example, `@{AddManagerAsRecipientType = "Bcc"}`. - - You can use this action in DLP policies that are scoped only to Exchange. - - PswsHashtable - - PswsHashtable - - - None - - - 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 50. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 = <Append | Prepend>; FallbackAction = <Wrap | Ignore | Reject> }`. - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Boolean - - Boolean - - - None - - - BlockAccessScope - - The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: - - All: Block access to everyone except the owner and the last modifier. - - PerUser: Block access to external users. - - PerAnonymousUser: Block access to people through the "Anyone with the link" option in SharePoint and OneDrive. - - BlockAccessScope - - BlockAccessScope - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - ContentExtensionMatchesWords - - The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - DocumentIsPasswordProtected - - The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - $true | $false - - $true | $false - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - DocumentNameMatchesPatterns - - The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule 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"`. - The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DocumentNameMatchesWords - - The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the file 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - - - - - None - - - 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. - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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 inside the organization. - - NotInOrganization: The rule isn't applied to content that's accessible outside the organization. - - None: The exception isn't used. - - AccessScope - - AccessScope - - - None - - - 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 50. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. - Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see What the sensitive information types in Exchange look for (https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). - - PswsHashtable[] - - PswsHashtable[] - - - None - - - ExceptIfContentExtensionMatchesWords - - The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentIsPasswordProtected - - The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - - $true: Look for password protected files. - - $false: Don't look for password protected files. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfDocumentNameMatchesPatterns - - The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule 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"`. - The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfDocumentNameMatchesWords - - The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the file 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - FromScope - - FromScope - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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: Encrypted messages. - - PermissionControlled: Messages that have specific permissions configured. - - ReadReceipt: Read receipts. - - Signed: Digitally signed messages. - - You can use this exception in DLP policies that are scoped only to Exchange. - - MessageTypes - - MessageTypes - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this exception in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - WithImportance - - WithImportance - - - None - - - ExpiryDate - - This parameter is reserved for internal Microsoft use. - - DateTime - - DateTime - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - FromMemberOf - - This parameter is reserved for internal Microsoft use. - - SmtpAddress[] - - SmtpAddress[] - - - None - - - FromScope - - The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: - - InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. - - 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. - - FromScope - - FromScope - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - ReportContentOption[] - - ReportContentOption[] - - - None - - - 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: Encrypted messages. - - PermissionControlled: Messages that have specific permissions configured. - - ReadReceipt: Read receipts. - - Signed: Digitally signed messages. - - You can use this condition in DLP policies that are scoped only to Exchange. - - MessageTypes - - MessageTypes - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - OverrideOption[] - - OverrideOption[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - NotifyPolicyTipCustomTextTranslations - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - PrependSubject - - The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - PolicyRuleErrorAction - - PolicyRuleErrorAction - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 IP addresses or ranges separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - $true | $false - - $true | $false - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 10. - You can use this condition in DLP policies that are scoped only to Exchange. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - 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. - - <MultiValuedProperty> - - <MultiValuedProperty> - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - 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. - - WithImportance - - WithImportance - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-dlpcompliancerule - - - - - - Set-DlpEdmSchema - Set - DlpEdmSchema - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-DlpEdmSchema cmdlet to modify exact data match (EDM) data loss prevention (DLP) schemas in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - For an explanation and example of the EDM schema, see Define the schema for your database of sensitive information (https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification#define-the-schema-for-your-database-of-sensitive-information). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DlpEdmSchema - - 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 Get-Content cmdlet. For example, `( Byte[] (Get-Content -Encoding Byte -Path "C:\My Documents\<filename>" -ReadCount 0))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 Get-Content cmdlet. For example, `( Byte[] (Get-Content -Encoding Byte -Path "C:\My Documents\<filename>" -ReadCount 0))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - $edmSchemaXml = Get-Content "C:\My Documents\edm.xml" -Encoding Byte -ReadCount 0 -Set-DlpEdmSchema -FileData $edmSchemaXml -Confirm:$true - - This example modifies a DLP EDM schema. The first command reads the schema in the XML file to a variable, and the second command uses that information to modify the DLP EDM schema. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Set-DlpEdmSchema - - - - - - Set-DlpKeywordDictionary - Set - DlpKeywordDictionary - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DlpKeywordDictionary - - 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. - - SensitiveInformationTypeIdParameter - - SensitiveInformationTypeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies descriptive text for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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. The maximum file size limit is 100 KB. - - Byte[] - - Byte[] - - - None - - - Name - - The Name parameter specifies a unique name for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - SensitiveInformationTypeIdParameter - - SensitiveInformationTypeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies descriptive text for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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. The maximum file size limit is 100 KB. - - Byte[] - - Byte[] - - - None - - - Name - - The Name parameter specifies a unique name for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-dlpkeyworddictionary - - - - - - Set-DlpPolicy - Set - DlpPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-DlpPolicy - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the DLP policy. - - String - - String - - - None - - - 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. - - RuleMode - - RuleMode - - - None - - - Name - - The Name parameter specifies a unique name for the DLP policy. - - String - - String - - - None - - - State - - The State parameter enables or disables the DLP policy. Valid input for this parameter is Enabled or Disabled. - - RuleState - - RuleState - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - DlpPolicyIdParameter - - DlpPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the DLP policy. - - String - - String - - - None - - - 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. - - RuleMode - - RuleMode - - - None - - - Name - - The Name parameter specifies a unique name for the DLP policy. - - String - - String - - - None - - - State - - The State parameter enables or disables the DLP policy. Valid input for this parameter is Enabled or Disabled. - - RuleState - - RuleState - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-DlpPolicy "Employee Numbers" -State Disabled - - This example disables the DLP policy named Employee Numbers. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-dlppolicy - - - - - - Set-DlpSensitiveInformationType - Set - DlpSensitiveInformationType - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-DlpSensitiveInformationType - - 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 - - SensitiveInformationTypeIdParameter - - SensitiveInformationTypeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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://docs.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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - - SwitchParameter - - - 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://docs.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. - - CultureInfo - - CultureInfo - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - SensitiveInformationTypeIdParameter - - SensitiveInformationTypeIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - 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://docs.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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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://docs.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. - - CultureInfo - - CultureInfo - - - None - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype - - - - - - Set-DlpSensitiveInformationTypeRulePackage - Set - DlpSensitiveInformationTypeRulePackage - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.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 Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-DlpSensitiveInformationTypeRulePackage - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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))`. - - Byte[] - - Byte[] - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtyperulepackage - - - - - - Set-HoldCompliancePolicy - Set - HoldCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-HoldCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-HoldCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - SwitchParameter - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 Online site `https://contoso.sharepoint.com/sites/teams/finance`. - - Removes public folders. - - Updates the comment. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-holdcompliancepolicy - - - - - - Set-HoldComplianceRule - Set - HoldComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-HoldComplianceRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - HoldDurationHint - - HoldDurationHint - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - HoldDurationHint - - HoldDurationHint - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-holdcompliancerule - - - - - - Set-HostedConnectionFilterPolicy - Set - HostedConnectionFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-HostedConnectionFilterPolicy - - 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. - - HostedConnectionFilterPolicyIdParameter - - HostedConnectionFilterPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - ConfigurationXmlRaw - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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, `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",...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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, `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",...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MakeDefault - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - HostedConnectionFilterPolicyIdParameter - - HostedConnectionFilterPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - ConfigurationXmlRaw - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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, `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",...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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, `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",...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MakeDefault - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-hostedconnectionfilterpolicy - - - - - - Set-HostedContentFilterPolicy - Set - HostedContentFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - For more information about the limits for allowed and blocked senders, see Exchange Online Protection Limits (https://docs.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). - - - - Set-HostedContentFilterPolicy - - 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 - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - AllowedSenderDomains - - The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. Caution : Think very carefully before you add domains here. For more information, see Create safe sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedSenders - - The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. Caution : Think very carefully before you add senders here. For more information, see Create safe sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 9 (high confidence spam). Valid values are one or more SMTP domains. Note : Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see Create block sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. Note : Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see Create block sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - NoAction - - Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - BulkThreshold - - The BulkThreshold parameter specifies the BCL that triggers the BulkSpamAction on the message (greater than the specified value, not greater than or equal to). A valid value is an integer from 1 to 9, and the default value is 7. A higher value indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see Bulk compliant level (BCL) in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/bulk-complaint-level-values). - - Int32 - - Int32 - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DownloadLink - - The DownloadLink parameter shows or hides a link in end-user spam quarantine notifications to download the Junk Email Reporting Tool for Outlook. Valid values are: - - $true: end-user spam quarantine notifications contain a link to download the Junk Email Reporting Tool for Outlook. - - $false: end-user spam quarantine notifications don't contain the link. This is the default value. - - This parameter is only meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - Boolean - - Boolean - - - None - - - EnableEndUserSpamNotifications - - The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notifications. Valid values are: - - $true: End-users periodically receive notifications when a messages that was supposed to be delivered to them was quarantined as spam. When you use this value, you can also use the EndUserSpamNotificationCustomSubject, EndUserSpamNotificationFrequency, and EndUserSpamNotificationLanguage parameters. - - $false: end-user spam quarantine notifications are disabled. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EndUserSpamNotificationCustomFromAddress - - This parameter has been deprecated and is no longer used. - - SmtpAddress - - SmtpAddress - - - None - - - EndUserSpamNotificationCustomFromName - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - EndUserSpamNotificationCustomSubject - - The EndUserSpamNotificationCustomSubject parameter specifies a custom subject for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks ("). - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - String - - String - - - None - - - EndUserSpamNotificationFrequency - - The EndUserSpamNotificationFrequency parameter specifies the repeat interval in days that end-user spam quarantine notifications are sent. A valid value is an integer between 1 and 15. The default value is 3. - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - Int32 - - Int32 - - - None - - - EndUserSpamNotificationLanguage - - The EndUserSpamNotificationLanguage parameter specifies the language of end-user spam quarantine notifications. Valid values are: - Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. - The default value is Default, which means end-user spam quarantine notifications use the default language of the cloud-based organization. - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - EsnLanguage - - EsnLanguage - - - None - - - EndUserSpamNotificationLimit - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - HighConfidencePhishAction - - The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is only available to admins. - - PhishFilteringAction - - PhishFilteringAction - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - Quarantine: Move the message to the quarantine. The quarantined message is only available to admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - IncreaseScoreWithBizOrInfoUrls - - Note : This setting is part of Advanced Spam Filtering (ASF) and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links to .biz or .info domains are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithImageLinks - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain image links to remote websites are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithNumericIps - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links to IP addresses are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithRedirectToOtherPort - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - 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. - - Boolean - - Boolean - - - None - - - LanguageBlockList - - The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported ISO 639-1 two-letter language code: - af, ar, az, be, bg, bn, br, bs, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, fy, ga, gl, gu, ha, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kl, kn, ko, ku, ky, la, lb, lt, lv, mi, mk, ml, mn, mr, ms, mt, nb, nl, nn, pa, pl, ps, pt, rm, ro, ru, se, sk, sl, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, uz, vi, wen, yi, zh-cn, zh-tw, and zu. - A reference for two-letter language codes is available at ISO 639-2 (https://www.loc.gov/standards/iso639-2/php/code_list.php). Note that not all possible language codes are available as input for this parameter. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MakeDefault - - The MakeDefault switch makes the specified spam filter policy the default spam filter policy. You don't have 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). - - - SwitchParameter - - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamEmbedTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML <embed> 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 <embed> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamEmptyMessages - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFormTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML <form> 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 <form> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFramesInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML <frame> or <iframe> 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 <frame> or <iframe> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFromAddressAuthFail - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamJavaScriptInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamNdrBackscatter - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as backscatter ). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamObjectTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML <object> 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 <object> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamSensitiveWordList - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamSpfRecordHardFail - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamWebBugsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - 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 ("). - - String - - String - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - 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. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the k Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - 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. - - Boolean - - Boolean - - - None - - - TestModeAction - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\ or MarkAsSpam\ ASF parameters are set to the value Test. Valid values are: - - None: This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringTestModeAction - - SpamFilteringTestModeAction - - - None - - - TestModeBccToRecipients - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. - Valid input for this parameter is an email address. Separate multiple email addresses with commas. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - AllowedSenderDomains - - The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. Caution : Think very carefully before you add domains here. For more information, see Create safe sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AllowedSenders - - The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. Caution : Think very carefully before you add senders here. For more information, see Create safe sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 9 (high confidence spam). Valid values are one or more SMTP domains. Note : Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see Create block sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. Note : Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see Create block sender lists in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). - To enter 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - NoAction - - Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - BulkThreshold - - The BulkThreshold parameter specifies the BCL that triggers the BulkSpamAction on the message (greater than the specified value, not greater than or equal to). A valid value is an integer from 1 to 9, and the default value is 7. A higher value indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see Bulk compliant level (BCL) in EOP (https://docs.microsoft.com/microsoft-365/security/office-365-security/bulk-complaint-level-values). - - Int32 - - Int32 - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DownloadLink - - The DownloadLink parameter shows or hides a link in end-user spam quarantine notifications to download the Junk Email Reporting Tool for Outlook. Valid values are: - - $true: end-user spam quarantine notifications contain a link to download the Junk Email Reporting Tool for Outlook. - - $false: end-user spam quarantine notifications don't contain the link. This is the default value. - - This parameter is only meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - Boolean - - Boolean - - - None - - - EnableEndUserSpamNotifications - - The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notifications. Valid values are: - - $true: End-users periodically receive notifications when a messages that was supposed to be delivered to them was quarantined as spam. When you use this value, you can also use the EndUserSpamNotificationCustomSubject, EndUserSpamNotificationFrequency, and EndUserSpamNotificationLanguage parameters. - - $false: end-user spam quarantine notifications are disabled. This is the default value. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EndUserSpamNotificationCustomFromAddress - - This parameter has been deprecated and is no longer used. - - SmtpAddress - - SmtpAddress - - - None - - - EndUserSpamNotificationCustomFromName - - This parameter has been deprecated and is no longer used. - - String - - String - - - None - - - EndUserSpamNotificationCustomSubject - - The EndUserSpamNotificationCustomSubject parameter specifies a custom subject for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks ("). - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - String - - String - - - None - - - EndUserSpamNotificationFrequency - - The EndUserSpamNotificationFrequency parameter specifies the repeat interval in days that end-user spam quarantine notifications are sent. A valid value is an integer between 1 and 15. The default value is 3. - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - Int32 - - Int32 - - - None - - - EndUserSpamNotificationLanguage - - The EndUserSpamNotificationLanguage parameter specifies the language of end-user spam quarantine notifications. Valid values are: - Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. - The default value is Default, which means end-user spam quarantine notifications use the default language of the cloud-based organization. - This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - - EsnLanguage - - EsnLanguage - - - None - - - EndUserSpamNotificationLimit - - This parameter is reserved for internal Microsoft use. - - Int32 - - Int32 - - - None - - - HighConfidencePhishAction - - The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - - MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is only available to admins. - - PhishFilteringAction - - PhishFilteringAction - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - Quarantine: Move the message to the quarantine. The quarantined message is only available to admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - IncreaseScoreWithBizOrInfoUrls - - Note : This setting is part of Advanced Spam Filtering (ASF) and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links to .biz or .info domains are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithImageLinks - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain image links to remote websites are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithNumericIps - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links to IP addresses are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - IncreaseScoreWithRedirectToOtherPort - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. - - Test: The action specified by the TestModeAction parameter is taken on the message. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - 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. - - Boolean - - Boolean - - - None - - - LanguageBlockList - - The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported ISO 639-1 two-letter language code: - af, ar, az, be, bg, bn, br, bs, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, fy, ga, gl, gu, ha, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kl, kn, ko, ku, ky, la, lb, lt, lv, mi, mk, ml, mn, mr, ms, mt, nb, nl, nn, pa, pl, ps, pt, rm, ro, ru, se, sk, sl, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, uz, vi, wen, yi, zh-cn, zh-tw, and zu. - A reference for two-letter language codes is available at ISO 639-2 (https://www.loc.gov/standards/iso639-2/php/code_list.php). Note that not all possible language codes are available as input for this parameter. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MakeDefault - - The MakeDefault switch makes the specified spam filter policy the default spam filter policy. You don't have 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). - - SwitchParameter - - SwitchParameter - - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamEmbedTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML <embed> 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 <embed> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamEmptyMessages - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFormTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML <form> 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 <form> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFramesInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML <frame> or <iframe> 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 <frame> or <iframe> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamFromAddressAuthFail - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamJavaScriptInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamNdrBackscatter - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as backscatter ). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamObjectTagsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML <object> 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 <object> 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamSensitiveWordList - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamSpfRecordHardFail - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - MarkAsSpamWebBugsInHtml - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringOption - - SpamFilteringOption - - - None - - - 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 ("). - - String - - String - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. The message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - 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. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, the message is only moved if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see Configure junk email settings on Exchange Online mailboxes (https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the k Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). - Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. - - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - - SpamFilteringAction - - SpamFilteringAction - - - None - - - 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. - - Boolean - - Boolean - - - None - - - TestModeAction - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\ or MarkAsSpam\ ASF parameters are set to the value Test. Valid values are: - - None: This is the default value, and we recommend that you don't change it. - - 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. - - SpamFilteringTestModeAction - - SpamFilteringTestModeAction - - - None - - - TestModeBccToRecipients - - Note : This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. - Valid input for this parameter is an email address. Separate multiple email addresses with commas. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-hostedcontentfilterpolicy - - - Safe sender and blocked sender lists in Exchange Online - https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-sender-and-blocked-sender-lists-faq - - - - - - Set-HostedContentFilterRule - Set - HostedContentFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-HostedContentFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - ExceptIfSentToMemberOf - - The ExceptIfSentToMemberOf parameter specifies an exception for the rule 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SentToMemberOf - - The SentToMemberOf parameter specifies a condition for the rule 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ExceptIfRecipientDomainIs - - The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - ExceptIfSentToMemberOf - - The ExceptIfSentToMemberOf parameter specifies an exception for the rule 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - HostedContentFilterPolicyIdParameter - - HostedContentFilterPolicyIdParameter - - - None - - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - RecipientDomainIs - - The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SentToMemberOf - - The SentToMemberOf parameter specifies a condition for the rule 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-hostedcontentfilterrule - - - - - - Set-HostedOutboundSpamFilterPolicy - Set - HostedOutboundSpamFilterPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-HostedOutboundSpamFilterPolicy - - 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 - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - 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. - - - Alert - BlockUserForToday - BlockUser - - OutboundRecipientLimitsExceededAction - - OutboundRecipientLimitsExceededAction - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AutoForwardingMode - - Note : Before September 2020, this setting is available but not enforced. - The AutoForwardingMode specifies how the policy controls automatic email forwarding to outbound recipients. Valid values are: - - Automatic: Automatic external email forwarding is blocked by the system. This is the default value. - - On: Automatic external email forwarding is not restricted. - - Off: Automatic external email forwarding is disabled and will result in a non-delivery report (also known as an NDR or bounce message) to the sender. - - This setting applies only to cloud-based mailboxes, and automatic forwarding to internal recipients is not affected by this setting. - - - Automatic - Off - On - - AutoForwardingMode - - AutoForwardingMode - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - NotifyOutboundSpam - - Note : This setting has been replaced by the default alert policy named User restricted from sending email , which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see Verify the alert settings for restricted users (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - 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. - - Boolean - - Boolean - - - None - - - NotifyOutboundSpamRecipients - - Note : This setting has been replaced by the default alert policy named User restricted from sending email , which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see Verify the alert settings for restricted users (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). - - UInt32 - - UInt32 - - - None - - - 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://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). - - UInt32 - - UInt32 - - - None - - - 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://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). - - UInt32 - - UInt32 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - 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. - - OutboundRecipientLimitsExceededAction - - OutboundRecipientLimitsExceededAction - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AutoForwardingMode - - Note : Before September 2020, this setting is available but not enforced. - The AutoForwardingMode specifies how the policy controls automatic email forwarding to outbound recipients. Valid values are: - - Automatic: Automatic external email forwarding is blocked by the system. This is the default value. - - On: Automatic external email forwarding is not restricted. - - Off: Automatic external email forwarding is disabled and will result in a non-delivery report (also known as an NDR or bounce message) to the sender. - - This setting applies only to cloud-based mailboxes, and automatic forwarding to internal recipients is not affected by this setting. - - AutoForwardingMode - - AutoForwardingMode - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - NotifyOutboundSpam - - Note : This setting has been replaced by the default alert policy named User restricted from sending email , which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see Verify the alert settings for restricted users (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - 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. - - Boolean - - Boolean - - - None - - - NotifyOutboundSpamRecipients - - Note : This setting has been replaced by the default alert policy named User restricted from sending email , which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see Verify the alert settings for restricted users (https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). - - UInt32 - - UInt32 - - - None - - - 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://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). - - UInt32 - - UInt32 - - - None - - - 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://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1). - - UInt32 - - UInt32 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterpolicy - - - - - - Set-HostedOutboundSpamFilterRule - Set - HostedOutboundSpamFilterRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-HostedOutboundSpamFilterRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - HostedOutboundSpamFilterPolicyIdParameter - - HostedOutboundSpamFilterPolicyIdParameter - - - None - - - 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: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-HostedOutboundSpamFilterRule -Identity "Contoso Executives" -ExceptIfFrom "Elizabeth Brunner" - - This example adds an exception to the existing rule named Contoso Executives. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterrule - - - - - - Set-InboundConnector - Set - InboundConnector - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Inbound connectors accept email messages from remote domains that require specific configuration options. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-InboundConnector - - Identity - - The Identity parameter specifies the Inbound connector you want to change. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - CloudServicesMailEnabled - - Note : We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://docs.microsoft.com/exchange/hybrid-configuration-wizard). - 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. - - Boolean - - Boolean - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - TenantConnectorSource - - TenantConnectorSource - - - None - - - 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. - - TenantConnectorType - - TenantConnectorType - - - None - - - 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: - - 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 specify multiple IP addresses or address range entries separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EFSkipMailGateway - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EFTestMode - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Enabled - - The Enabled parameter enables or disables the connector. Valid input for this parameter is $true or $false. The default value is $true. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies a descriptive name for the connector. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RestrictDomainsToCertificate - - The RestrictDomainsToCertificate parameter specifies that Microsoft 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ScanAndDropRecipients - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderIPAddresses - - The SenderIPAddresses parameter specifies the remote IPV4 IP addresses from which this connector accepts messages. IPv6 addresses are not supported. 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - TlsCertificate - - TlsCertificate - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the Inbound connector you want to change. - - InboundConnectorIdParameter - - InboundConnectorIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - CloudServicesMailEnabled - - Note : We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://docs.microsoft.com/exchange/hybrid-configuration-wizard). - 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. - - Boolean - - Boolean - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - TenantConnectorSource - - TenantConnectorSource - - - None - - - 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. - - TenantConnectorType - - TenantConnectorType - - - None - - - 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: - - 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 specify multiple IP addresses or address range entries separated by commas. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EFSkipMailGateway - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EFTestMode - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Enabled - - The Enabled parameter enables or disables the connector. Valid input for this parameter is $true or $false. The default value is $true. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies a descriptive name for the connector. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RestrictDomainsToCertificate - - The RestrictDomainsToCertificate parameter specifies that Microsoft 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ScanAndDropRecipients - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SenderIPAddresses - - The SenderIPAddresses parameter specifies the remote IPV4 IP addresses from which this connector accepts messages. IPv6 addresses are not supported. 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - TlsCertificate - - TlsCertificate - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-inboundconnector - - - - - - Set-InboxRule - Set - InboxRule - - This cmdlet is available in 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-InboxRule cmdlet to modify existing Inbox rules in mailboxes. Inbox rules process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Set-InboxRule cmdlet allows you to modify the rule conditions, exceptions, and actions. - When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-InboxRule - - Identity - - 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: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). - - On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - AlwaysDeleteOutlookRulesBlob - - The AlwaysDeleteOutlookRulesBlob switch hides a warning message when end users or administrators use Outlook on the web or PowerShell to modify Inbox rules. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - ApplyCategory - - The ApplyCategory parameter specifies an action for the Inbox rule that applies the specified category to messages. A valid value is any text value that you want to define as a category. You can specify multiple categories separated by commas. If the value contains spaces, enclose the value in quotation marks ("). - The categories that you specify for this parameter are defined in the mailbox (they aren't shared between mailboxes). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - BodyContainsWords - - The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - CopyToFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DeleteMessage - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfBodyContainsWords - - The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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 BodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfFlaggedForAction - - 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. - - String - - String - - - None - - - 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 - - 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"`. - The corresponding condition parameter to this exception is From. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - ExceptIfFromAddressContainsWords - - The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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 FromAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - ExceptIfHasAttachment - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfHasClassification - - The ExceptIfHasClassification parameter specifies an exception for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. - The corresponding condition parameter to this exception is HasClassification. - - MessageClassificationIdParameter[] - - MessageClassificationIdParameter[] - - - None - - - ExceptIfHeaderContainsWords - - The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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 HeaderContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfMessageTypeMatches - - 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. - - InboxRuleMessageType - - InboxRuleMessageType - - - None - - - ExceptIfMyNameInCcBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameInToBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameInToOrCcBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameNotInToBox - - 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. - - Boolean - - Boolean - - - None - - - 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". - The corresponding condition parameter to this exception is ReceivedAfterDate. - - ExDateTime - - ExDateTime - - - None - - - 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". - The corresponding condition parameter to this exception is ReceivedBeforeDate. - - ExDateTime - - ExDateTime - - - None - - - 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: `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 corresponding condition parameter to this exception is RecipientAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSentOnlyToMe - - 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. - - Boolean - - Boolean - - - None - - - 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"`. - The corresponding condition parameter to this exception is SentTo. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - ExceptIfSubjectContainsWords - - The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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 SubjectContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSubjectOrBodyContainsWords - - The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfWithImportance - - 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. - - Importance - - Importance - - - None - - - ExceptIfWithinSizeRangeMaximum - - The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for the Inbox rule that looks for messages that smaller than specified maximum size. - When you enter a value, qualify the value with one of the following units: - - 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 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - ExceptIfWithinSizeRangeMinimum - - The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for the Inbox rule that looks for messages that are larger than the specified minimum size. - When you enter a value, qualify the value with one of the following units: - - 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 ExceptIfWithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of ExceptIfWithinSizeRangeMaximum. - The corresponding condition parameter to this exception is WithinSizeRangeMinimum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - ExceptIfWithSensitivity - - 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. - - Sensitivity - - Sensitivity - - - None - - - FlaggedForAction - - 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 - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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: - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - 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"`. - The corresponding exception parameter to this condition is ExceptIfFrom. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - FromAddressContainsWords - - The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfFromAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - HasClassification - - The HasClassification parameter specifies a condition for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. - The corresponding exception parameter to this condition is ExceptIfHasClassification. - - MessageClassificationIdParameter[] - - MessageClassificationIdParameter[] - - - None - - - HeaderContainsWords - - The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfHeaderContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - MarkAsRead - - 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. - - Boolean - - Boolean - - - None - - - MarkImportance - - The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - - Low - - Normal - - High - - Importance - - Importance - - - None - - - MessageTypeMatches - - 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. - - InboxRuleMessageType - - InboxRuleMessageType - - - None - - - MoveToFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - MyNameInCcBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameInToBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameInToOrCcBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameNotInToBox - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Priority - - The Priority parameter specifies a priority for the Inbox rule that determines the order of rule processing. A lower integer value indicates a higher priority, - - Int32 - - Int32 - - - None - - - 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". - The corresponding exception parameter to this condition is ExceptIfReceivedAfterDate. - - ExDateTime - - ExDateTime - - - None - - - 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". - The corresponding exception parameter to this condition is ExceptIfReceivedBeforeDate. - - ExDateTime - - ExDateTime - - - None - - - 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: `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 corresponding exception parameter to this condition is ExceptIfRecipientAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RedirectTo - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SendTextMessageNotificationTo - - 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: `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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SentOnlyToMe - - 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. - - Boolean - - Boolean - - - None - - - 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: - - 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"`. - The corresponding exception parameter to this condition is ExceptIfSentTo. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - StopProcessingRules - - 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). - - Boolean - - Boolean - - - None - - - SubjectContainsWords - - The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfSubjectContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SubjectOrBodyContainsWords - - The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfSubjectOrBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WithImportance - - 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. - - Importance - - Importance - - - None - - - WithinSizeRangeMaximum - - The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox rule that looks for messages that are smaller than specified maximum size. - When you enter a value, qualify the value with one of the following units: - - 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 WithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of WithinSizeRangeMinimum. - The corresponding exception parameter to this condition is ExceptIfWithinSizeRangeMaximum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - WithinSizeRangeMinimum - - The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox rule that looks for messages that are larger than the specified minimum size. - When you enter a value, qualify the value with one of the following units: - - 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 WithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of WithinSizeRangeMaximum. - The corresponding exception parameter to this condition is ExceptIfWithinSizeRangeMinimum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - WithSensitivity - - 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. - - Sensitivity - - Sensitivity - - - None - - - - - - Identity - - 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: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). - - On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). - - InboxRuleIdParameter - - InboxRuleIdParameter - - - None - - - AlwaysDeleteOutlookRulesBlob - - The AlwaysDeleteOutlookRulesBlob switch hides a warning message when end users or administrators use Outlook on the web or PowerShell to modify Inbox rules. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - ApplyCategory - - The ApplyCategory parameter specifies an action for the Inbox rule that applies the specified category to messages. A valid value is any text value that you want to define as a category. You can specify multiple categories separated by commas. If the value contains spaces, enclose the value in quotation marks ("). - The categories that you specify for this parameter are defined in the mailbox (they aren't shared between mailboxes). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - BodyContainsWords - - The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - CopyToFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - DeleteMessage - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfBodyContainsWords - - The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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 BodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfFlaggedForAction - - 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. - - String - - String - - - None - - - 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 - - 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"`. - The corresponding condition parameter to this exception is From. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - ExceptIfFromAddressContainsWords - - The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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 FromAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - ExceptIfHasAttachment - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfHasClassification - - The ExceptIfHasClassification parameter specifies an exception for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. - The corresponding condition parameter to this exception is HasClassification. - - MessageClassificationIdParameter[] - - MessageClassificationIdParameter[] - - - None - - - ExceptIfHeaderContainsWords - - The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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 HeaderContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfMessageTypeMatches - - 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. - - InboxRuleMessageType - - InboxRuleMessageType - - - None - - - ExceptIfMyNameInCcBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameInToBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameInToOrCcBox - - 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. - - Boolean - - Boolean - - - None - - - ExceptIfMyNameNotInToBox - - 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. - - Boolean - - Boolean - - - None - - - 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". - The corresponding condition parameter to this exception is ReceivedAfterDate. - - ExDateTime - - ExDateTime - - - None - - - 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". - The corresponding condition parameter to this exception is ReceivedBeforeDate. - - ExDateTime - - ExDateTime - - - None - - - 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: `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 corresponding condition parameter to this exception is RecipientAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSentOnlyToMe - - 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. - - Boolean - - Boolean - - - None - - - 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"`. - The corresponding condition parameter to this exception is SentTo. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - ExceptIfSubjectContainsWords - - The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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 SubjectContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfSubjectOrBodyContainsWords - - The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptIfWithImportance - - 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. - - Importance - - Importance - - - None - - - ExceptIfWithinSizeRangeMaximum - - The ExceptIfWithinSizeRangeMaximum parameter specifies part of an exception for the Inbox rule that looks for messages that smaller than specified maximum size. - When you enter a value, qualify the value with one of the following units: - - 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 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - ExceptIfWithinSizeRangeMinimum - - The ExceptIfWithinSizeRangeMinimum parameter specifies part of an exception for the Inbox rule that looks for messages that are larger than the specified minimum size. - When you enter a value, qualify the value with one of the following units: - - 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 ExceptIfWithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of ExceptIfWithinSizeRangeMaximum. - The corresponding condition parameter to this exception is WithinSizeRangeMinimum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - ExceptIfWithSensitivity - - 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. - - Sensitivity - - Sensitivity - - - None - - - FlaggedForAction - - 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 - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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: - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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: - - 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"`. - The corresponding exception parameter to this condition is ExceptIfFrom. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - FromAddressContainsWords - - The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfFromAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - AggregationSubscriptionIdentity[] - - AggregationSubscriptionIdentity[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - HasClassification - - The HasClassification parameter specifies a condition for the Inbox rule that looks for messages with the specified message classification. You can find message classifications by using the Get-MessageClassification cmdlet. You can specify multiple message classifications separated by commas. - The corresponding exception parameter to this condition is ExceptIfHasClassification. - - MessageClassificationIdParameter[] - - MessageClassificationIdParameter[] - - - None - - - HeaderContainsWords - - The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfHeaderContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - MarkAsRead - - 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. - - Boolean - - Boolean - - - None - - - MarkImportance - - The MarkImportance parameter specifies an action for the Inbox rule that marks messages with the specified importance flag. Valid values are: - - Low - - Normal - - High - - Importance - - Importance - - - None - - - MessageTypeMatches - - 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. - - InboxRuleMessageType - - InboxRuleMessageType - - - None - - - MoveToFolder - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - MyNameInCcBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameInToBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameInToOrCcBox - - 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. - - Boolean - - Boolean - - - None - - - MyNameNotInToBox - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Priority - - The Priority parameter specifies a priority for the Inbox rule that determines the order of rule processing. A lower integer value indicates a higher priority, - - Int32 - - Int32 - - - None - - - 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". - The corresponding exception parameter to this condition is ExceptIfReceivedAfterDate. - - ExDateTime - - ExDateTime - - - None - - - 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". - The corresponding exception parameter to this condition is ExceptIfReceivedBeforeDate. - - ExDateTime - - ExDateTime - - - None - - - 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: `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 corresponding exception parameter to this condition is ExceptIfRecipientAddressContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RedirectTo - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - SendTextMessageNotificationTo - - 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: `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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SentOnlyToMe - - 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. - - Boolean - - Boolean - - - None - - - 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: - - 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"`. - The corresponding exception parameter to this condition is ExceptIfSentTo. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - StopProcessingRules - - 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). - - Boolean - - Boolean - - - None - - - SubjectContainsWords - - The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfSubjectContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SubjectOrBodyContainsWords - - The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. - To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - The corresponding exception parameter to this condition is ExceptIfSubjectOrBodyContainsWords. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WithImportance - - 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. - - Importance - - Importance - - - None - - - WithinSizeRangeMaximum - - The WithinSizeRangeMaximum parameter specifies part of a condition for the Inbox rule that looks for messages that are smaller than specified maximum size. - When you enter a value, qualify the value with one of the following units: - - 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 WithinSizeRangeMinimum parameter, and the value of this parameter must be greater than the value of WithinSizeRangeMinimum. - The corresponding exception parameter to this condition is ExceptIfWithinSizeRangeMaximum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - WithinSizeRangeMinimum - - The WithinSizeRangeMinimum parameter specifies part of a condition for the Inbox rule that looks for messages that are larger than the specified minimum size. - When you enter a value, qualify the value with one of the following units: - - 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 WithinSizeRangeMaximum parameter, and the value of this parameter must be less than the value of WithinSizeRangeMaximum. - The corresponding exception parameter to this condition is ExceptIfWithinSizeRangeMinimum. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - WithSensitivity - - 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. - - Sensitivity - - Sensitivity - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-InboxRule 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-inboxrule - - - - - - Set-InformationBarrierPolicy - Set - InformationBarrierPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-InformationBarrierPolicy cmdlet to modify information barrier policies in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Information barrier policies are not in effect until you set them to active status, and then apply the policies: - - (If needed): Define a policy to block communications between segments (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#scenario-1-block-communications-between-segments). - After all of your policies are defined: Apply information barrier policies (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#part-3-apply-information-barrier-policies). - For more information, see Information barrier policies (https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-InformationBarrierPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - State - - The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: - - Active - - Inactive - - - Inactive - Active - - EopInformationBarrierPolicyState - - EopInformationBarrierPolicyState - - - None - - - - Set-InformationBarrierPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - SegmentAllowedFilter - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - State - - The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: - - Active - - Inactive - - - Inactive - Active - - EopInformationBarrierPolicyState - - EopInformationBarrierPolicyState - - - None - - - - Set-InformationBarrierPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - State - - The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: - - Active - - Inactive - - - Inactive - Active - - EopInformationBarrierPolicyState - - EopInformationBarrierPolicyState - - - None - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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". - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - SegmentAllowedFilter - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - State - - The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: - - Active - - Inactive - - EopInformationBarrierPolicyState - - EopInformationBarrierPolicyState - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-InformationBarrierPolicy -Identity 43c37853-ea10-4b90-a23d-ab8c93772471 -State Active - - This example activates the specified inactive information barrier policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-informationbarrierpolicy - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - New-InformationBarrierPolicy - https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy - - - - - - Set-Label - Set - Label - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-Label cmdlet to modify sensitivity labels in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center).. - - - - Set-Label - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - AdvancedSettings - - The AdvancedSettings parameter enables client-specific features and capabilities for a sensitivity label. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see Custom configurations for the Azure Information Protection unified labeling client (https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ApplyWaterMarkingLayout - - The ApplyWaterMarkingAlignment 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout - - - None - - - 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. - - String - - String - - - None - - - ColumnAssetCondition - - {{ Fill ColumnAssetCondition Description }} - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Conditions - - This parameter is reserved for internal Microsoft use. - - - - - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - ContentType - - {{ Fill ContentType Description }} - - MipLabelContentType - - MipLabelContentType - - - None - - - Disabled - - The Disabled parameter specifies whether to enable or disable the sensitivity label. Valid values are: - - $true: The label is disabled. - - $False: The label is enabled. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EncryptionDoubleKeyEncryptionUrl - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - EncryptionEnabled - - The EncryptionEnabled parameter specifies whether encryption in enabled. Value values are: - - $true: Encryption is enabled. - - $false: Encryption is disabled. - - Boolean - - Boolean - - - None - - - EncryptionEncryptOnly - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - LabelActions - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - LocaleSettings - - The LocaleSettings parameter specifies one or more localized label name 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 will have to give an empty value for that corresponding language. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MigrationId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - NextLabel - - This parameter is reserved for internal Microsoft use. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - PreviousLabel - - This parameter is reserved for internal Microsoft use. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Setting - - This parameter is reserved for internal Microsoft use. - - PswsHashtable - - PswsHashtable - - - None - - - Settings - - This parameter is reserved for internal Microsoft use. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType - - Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType - - - None - - - SiteExternalSharingControlType - - {{ Fill SiteExternalSharingControlType Description }} - - Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType - - Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType - - - None - - - SqlAssetCondition - - {{ Fill SqlAssetCondition Description }} - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - AdvancedSettings - - The AdvancedSettings parameter enables client-specific features and capabilities for a sensitivity label. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see Custom configurations for the Azure Information Protection unified labeling client (https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - ApplyWaterMarkingLayout - - The ApplyWaterMarkingAlignment 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout - - - None - - - 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. - - String - - String - - - None - - - ColumnAssetCondition - - {{ Fill ColumnAssetCondition Description }} - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Conditions - - This parameter is reserved for internal Microsoft use. - - - - - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - ContentType - - {{ Fill ContentType Description }} - - MipLabelContentType - - MipLabelContentType - - - None - - - Disabled - - The Disabled parameter specifies whether to enable or disable the sensitivity label. Valid values are: - - $true: The label is disabled. - - $False: The label is enabled. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - EncryptionDoubleKeyEncryptionUrl - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - EncryptionEnabled - - The EncryptionEnabled parameter specifies whether encryption in enabled. Value values are: - - $true: Encryption is enabled. - - $false: Encryption is disabled. - - Boolean - - Boolean - - - None - - - EncryptionEncryptOnly - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType - - Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - LabelActions - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - LocaleSettings - - The LocaleSettings parameter specifies one or more localized label name 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 will have to give an empty value for that corresponding language. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - MigrationId - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - NextLabel - - This parameter is reserved for internal Microsoft use. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - PreviousLabel - - This parameter is reserved for internal Microsoft use. - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - Int32 - - Int32 - - - None - - - Setting - - This parameter is reserved for internal Microsoft use. - - PswsHashtable - - PswsHashtable - - - None - - - Settings - - This parameter is reserved for internal Microsoft use. - - PswsHashtable - - PswsHashtable - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType - - Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType - - - None - - - SiteExternalSharingControlType - - {{ Fill SiteExternalSharingControlType Description }} - - Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType - - Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType - - - None - - - SqlAssetCondition - - {{ Fill SqlAssetCondition Description }} - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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). - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance/set-label - - - New-Label - - - - - - - Set-LabelPolicy - Set - LabelPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-Label cmdlet to modify sensitivity label policies in your organization. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-LabelPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - - SwitchParameter - - - False - - - AdvancedSettings - - The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see Custom configurations for the Azure Information Protection unified labeling client (https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). - - PswsHashtable - - PswsHashtable - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - NextLabelPolicy - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - PreviousLabelPolicy - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-LabelPolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddModernGroupLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AdvancedSettings - - The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see Custom configurations for the Azure Information Protection unified labeling client (https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). - - PswsHashtable - - PswsHashtable - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - False - - - NextLabelPolicy - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - PreviousLabelPolicy - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveModernGroupLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - RetryDistribution - - The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. - 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. - - SwitchParameter - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddModernGroupLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AdvancedSettings - - The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see Custom configurations for the Azure Information Protection unified labeling client (https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). - - PswsHashtable - - PswsHashtable - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - NextLabelPolicy - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - PreviousLabelPolicy - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveModernGroupLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-LabelPolicy -Identity "Global Policy" -AdvancedSettings @{EnableCustomPermissions="False"} - - This example configures the specified advanced setting for the sensitivity label policy name Global Policy. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-labelpolicy - - - - - - Set-MalwareFilterPolicy - Set - MalwareFilterPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MalwareFilterPolicy - - 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 - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - CustomAlertText - - The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the Action parameter value is ReplaceWithCustomAlert. - - String - - String - - - None - - - CustomExternalBody - - The CustomExternalBody parameter specifies the body of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableExternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomExternalSubject - - The CustomExternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableExternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomFromAddress - - The CustomFromAddress parameter specifies the From address of the custom notification message for malware detections in messages from internal or external senders. - This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: - - EnableExternalSenderAdminNotifications - - EnableInternalSenderAdminNotifications - - SmtpAddress - - SmtpAddress - - - None - - - CustomFromName - - The CustomFromName parameter specifies the From name of the custom notification message for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: - - EnableExternalSenderAdminNotifications - - EnableInternalSenderAdminNotifications - - String - - String - - - None - - - CustomInternalBody - - The CustomInternalBody parameter specifies the body of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). - TThis parameter is only meaningful when the CustomNotifications parameter value and the EnableInternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomInternalSubject - - The CustomInternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableInternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomNotifications - - The CustomNotifications parameter enables or disables custom notification messages for malware detections in messages from internal or external senders. Valid values are: - - $true: When malware is detected in a message, a custom notification message is sent to the message sender. You specify the details of message using the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. - - $false: Custom notifications to the original message sender are disabled. This is the default value. Default notification messages are sent if the EnableExternalSenderNotifications and EnableInternalSenderNotifications parameters are set to $true. - - Boolean - - Boolean - - - None - - - EnableExternalSenderAdminNotifications - - The EnableExternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from external senders. Valid values are: - - $true: When malware is detected in messages from external senders, send notification messages to the email address that's specified by the ExternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. - - $false: When malware is detected in messages from external senders, don't send administrator notifications. This is the default value. - - Boolean - - Boolean - - - None - - - EnableFileFilter - - This parameter is available only in the cloud-based service. - The EnableFileFilter parameter enables or disables common attachment blocking (also known as the Common Attachment Types Filter). Valid values are: - - $true: Common attachment blocking is enabled. The file types are defined by the FileTypes parameter. - - $false: Common attachment blocking is disabled. This is the default value. - - Boolean - - Boolean - - - None - - - EnableInternalSenderAdminNotifications - - The EnableInternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from internal senders. Valid values are: - - $true: When malware is detected in messages from internal senders, send notification messages to the email address that's specified by the InternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. - - $false: When malware is detected in messages from internal senders, don't send administrator notifications. This is the default value. - - Boolean - - Boolean - - - None - - - ExternalSenderAdminAddress - - The ExternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from external senders. - This parameter is only meaningful if the EnableExternalSenderAdminNotifications parameter is set to $true. - - SmtpAddress - - SmtpAddress - - - None - - - FileTypeAction - - The FileTypeAction parameter specifies the action applied to the message when any of the attachment(s) has an extension which is in the list in the FileTypes parameter. - This parameter is only meaningful when the EnableFileFilter parameter value is $true. - Valid values are: - - Quarantine: Handles the message without notifying the recipients. In Exchange Server, the message is deleted. In the cloud-based service, the message is quarantined. - - Reject: Rejects the message with an NDR (Non Delivery Receipt) to the sender of the message. This is the default action. As the message is rejected, there will be no copy of the message in the Quarantine. - - FileTypeFilteringAction - - FileTypeFilteringAction - - - None - - - FileTypes - - This parameter is available only in the cloud-based service. - The FileTypes parameter specifies the file types that are automatically blocked by common attachment blocking (also known as the Common Attachment Types Filter), regardless of content. The default values are: - - .ace - - .ani - - .app - - .cab - - .docm - - .exe - - .iso - - .jar - - .jnlp - - .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. - - String[] - - String[] - - - None - - - InternalSenderAdminAddress - - The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from internal senders. - This parameter is only meaningful if the EnableInternalSenderAdminNotifications parameter value is $true. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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 - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - CustomAlertText - - The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the Action parameter value is ReplaceWithCustomAlert. - - String - - String - - - None - - - CustomExternalBody - - The CustomExternalBody parameter specifies the body of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableExternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomExternalSubject - - The CustomExternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableExternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomFromAddress - - The CustomFromAddress parameter specifies the From address of the custom notification message for malware detections in messages from internal or external senders. - This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: - - EnableExternalSenderAdminNotifications - - EnableInternalSenderAdminNotifications - - SmtpAddress - - SmtpAddress - - - None - - - CustomFromName - - The CustomFromName parameter specifies the From name of the custom notification message for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: - - EnableExternalSenderAdminNotifications - - EnableInternalSenderAdminNotifications - - String - - String - - - None - - - CustomInternalBody - - The CustomInternalBody parameter specifies the body of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableInternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomInternalSubject - - The CustomInternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). - This parameter is only meaningful when the CustomNotifications parameter value and the EnableInternalSenderAdminNotifications parameter value are $true. - - String - - String - - - None - - - CustomNotifications - - The CustomNotifications parameter enables or disables custom notification messages for malware detections in messages from internal or external senders. Valid values are: - - $true: When malware is detected in a message, a custom notification message is sent to the message sender. You specify the details of message using the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. - - $false: Custom notifications to the original message sender are disabled. This is the default value. Default notification messages are sent if the EnableExternalSenderNotifications and EnableInternalSenderNotifications parameters are set to $true. - - Boolean - - Boolean - - - None - - - EnableExternalSenderAdminNotifications - - The EnableExternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from external senders. Valid values are: - - $true: When malware is detected in messages from external senders, send notification messages to the email address that's specified by the ExternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. - - $false: When malware is detected in messages from external senders, don't send administrator notifications. This is the default value. - - Boolean - - Boolean - - - None - - - EnableFileFilter - - This parameter is available only in the cloud-based service. - The EnableFileFilter parameter enables or disables common attachment blocking (also known as the Common Attachment Types Filter). Valid values are: - - $true: Common attachment blocking is enabled. The file types are defined by the FileTypes parameter. - - $false: Common attachment blocking is disabled. This is the default value. - - Boolean - - Boolean - - - None - - - EnableInternalSenderAdminNotifications - - The EnableInternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from internal senders. Valid values are: - - $true: When malware is detected in messages from internal senders, send notification messages to the email address that's specified by the InternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. - - $false: When malware is detected in messages from internal senders, don't send administrator notifications. This is the default value. - - Boolean - - Boolean - - - None - - - ExternalSenderAdminAddress - - The ExternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from external senders. - This parameter is only meaningful if the EnableExternalSenderAdminNotifications parameter is set to $true. - - SmtpAddress - - SmtpAddress - - - None - - - FileTypeAction - - The FileTypeAction parameter specifies the action applied to the message when any of the attachment(s) has an extension which is in the list in the FileTypes parameter. - This parameter is only meaningful when the EnableFileFilter parameter value is $true. - Valid values are: - - Quarantine: Handles the message without notifying the recipients. In Exchange Server, the message is deleted. In the cloud-based service, the message is quarantined. - - Reject: Rejects the message with an NDR (Non Delivery Receipt) to the sender of the message. This is the default action. As the message is rejected, there will be no copy of the message in the Quarantine. - - FileTypeFilteringAction - - FileTypeFilteringAction - - - None - - - FileTypes - - This parameter is available only in the cloud-based service. - The FileTypes parameter specifies the file types that are automatically blocked by common attachment blocking (also known as the Common Attachment Types Filter), regardless of content. The default values are: - - .ace - - .ani - - .app - - .cab - - .docm - - .exe - - .iso - - .jar - - .jnlp - - .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. - - String[] - - String[] - - - None - - - InternalSenderAdminAddress - - The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from internal senders. - This parameter is only meaningful if the EnableInternalSenderAdminNotifications parameter value is $true. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-MalwareFilterPolicy -Identity "Contoso Malware Filter Policy" -FileTypeAction Reject -EnableInternalSenderAdminNotifications $true -InternalSenderAdminAddress admin@contoso.com - - This example modifies the malware filter policy named Contoso Malware Filter Policy with the following settings: - - Reject messages that contain a blocked file type and notify the sender via an NDR. - - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-malwarefilterpolicy - - - - - - Set-MalwareFilterRule - Set - MalwareFilterRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MalwareFilterRule - - 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. - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - MalwareFilterPolicy - - The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule 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. - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - Name - - The Name parameter specifies a unique name for the malware filter rule. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - MalwareFilterPolicy - - The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule 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. - - MalwareFilterPolicyIdParameter - - MalwareFilterPolicyIdParameter - - - None - - - Name - - The Name parameter specifies a unique name for the malware filter rule. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-malwarefilterrule - - - - - - Set-OutboundConnector - Set - OutboundConnector - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Outbound connectors send email messages to remote domains that require specific configuration options. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-OutboundConnector - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - CloudServicesMailEnabled - - Note : We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://docs.microsoft.com/exchange/hybrid-configuration-wizard). - 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. - - Boolean - - Boolean - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - TenantConnectorSource - - TenantConnectorSource - - - None - - - 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. - - TenantConnectorType - - TenantConnectorType - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - SmtpDomainWithSubdomains - - SmtpDomainWithSubdomains - - - None - - - 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. - - TlsAuthLevel - - TlsAuthLevel - - - None - - - 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 specify the smart hosts by using the SmartHosts parameter in the same command. - - Boolean - - Boolean - - - None - - - 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. - - String[] - - String[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - CloudServicesMailEnabled - - Note : We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://docs.microsoft.com/exchange/hybrid-configuration-wizard). - 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. - - Boolean - - Boolean - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - TenantConnectorSource - - TenantConnectorSource - - - None - - - 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. - - TenantConnectorType - - TenantConnectorType - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - - DateTime - - DateTime - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - SmtpDomainWithSubdomains - - SmtpDomainWithSubdomains - - - None - - - 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. - - TlsAuthLevel - - TlsAuthLevel - - - None - - - 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 specify the smart hosts by using the SmartHosts parameter in the same command. - - Boolean - - Boolean - - - None - - - 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. - - String[] - - String[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-outboundconnector - - - - - - Set-PerimeterConfig - Set - PerimeterConfig - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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. - - - - Set-PerimeterConfig - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-perimeterconfig - - - - - - Set-PolicyTipConfig - Set - PolicyTipConfig - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-PolicyTipConfig - - Identity - - The Identity parameter specifies the custom Policy Tip you want to modify. You can use any value that uniquely identifies the custom Policy Tip. For example: - - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - - GUID - - Distinguished name (DN) - - PolicyTipConfigIdParameter - - PolicyTipConfigIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the custom Policy Tip you want to modify. You can use any value that uniquely identifies the custom Policy Tip. For example: - - `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs (https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - - GUID - - Distinguished name (DN) - - PolicyTipConfigIdParameter - - PolicyTipConfigIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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." - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-policytipconfig - - - - - - Set-ProtectionAlert - Set - ProtectionAlert - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-ProtectionAlert cmdlet to modify alert policies in the Security & Compliance Center. Note : You can't use this cmdlet to edit default alert policies. You can only modify alerts that you created using the New-ProtectionAlert cmdlet. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-ProtectionAlert - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - AlertAggregationType - - AlertAggregationType - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AlertFor - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies descriptive text for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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 (for example, `500`, `$true`, `$false`, or `$null`). - You can chain multiple search criteria together using the `-and` logical operator (for example, `"Criteria1 -and Criteria2"`). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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. - - String - - String - - - None - - - Name - - The Name parameter specifies the unique name for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - NotificationCulture - - The NotificationCulture parameter specifies the language or locale that's used for notifications. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - NotifyUser - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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). - - Int32 - - Int32 - - - None - - - 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). - - Int32 - - Int32 - - - None - - - Operation - - The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can specify multiple values separated by commas. - You can only use this parameter when the ThreatType parameter has the value Activity. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Severity - - The Severity parameter specifies the severity of the detection. Valid values are: - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - AlertAggregationType - - AlertAggregationType - - - None - - - 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). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AlertFor - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - AlertRuleCategory - - AlertRuleCategory - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies descriptive text for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.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 (for example, `500`, `$true`, `$false`, or `$null`). - You can chain multiple search criteria together using the `-and` logical operator (for example, `"Criteria1 -and Criteria2"`). - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - 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. - - String - - String - - - None - - - Name - - The Name parameter specifies the unique name for the alert policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - NotificationCulture - - The NotificationCulture parameter specifies the language or locale that's used for notifications. - Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - NotifyUser - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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). - - Int32 - - Int32 - - - None - - - 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). - - Int32 - - Int32 - - - None - - - Operation - - The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at Audited activities (https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can specify multiple values separated by commas. - You can only use this parameter when the ThreatType parameter has the value Activity. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Severity - - The Severity parameter specifies the severity of the detection. Valid values are: - - Low (This is the default value) - - Medium - - High - - RuleSeverity - - RuleSeverity - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-ProtectionAlert -Identity "Content search deleted" -Severity High - - This example sets the Severity of the detection to High. - - - - -------------------------- Example 2 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-protectionalert - - - - - - Set-RegulatoryComplianceUI - Set - RegulatoryComplianceUI - - This cmdlet is available only in the Security & Compliance Center. For more information, see Security & Compliance Center PowerShell (https://docs.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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-RegulatoryComplianceUI - - 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. - - Boolean - - Boolean - - - None - - - - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-RegulatoryComplianceUI -Enabled $true - - This example displays the UI option in retention label settings to mark content as a regulatory record. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-regulatorycomplianceui - - - - - - Set-RetentionCompliancePolicy - Set - RetentionCompliancePolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-RetentionCompliancePolicy cmdlet to modify existing retention policies in the Security & Compliance Center. 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 parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-RetentionCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-RetentionCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddSkypeLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveSkypeLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - Set-RetentionCompliancePolicy - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - SharePoint Online sites can't be added to the policy until they have been indexed. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - AddSkypeLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RemoveSkypeLocationException - - This parameter is reserved for internal Microsoft use. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 Online site `https://contoso.sharepoint.com/sites/teams/finance`. - - Removes public folders. - - Updates the comment. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-retentioncompliancepolicy - - - - - - Set-RetentionComplianceRule - Set - RetentionComplianceRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-RetentionComplianceRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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://docs.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. - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - You can't use this parameter for Teams retention rules. - - String - - String - - - None - - - 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://docs.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes)and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - RetentionComplianceAction - - The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - - Delete - - Keep - - KeepAndDelete - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - You can't use this parameter for Teams retention rules. - - HoldDurationHint - - HoldDurationHint - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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://docs.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. - - PswsHashtable[] - - PswsHashtable[] - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - You can't use this parameter for Teams retention rules. - - String - - String - - - None - - - 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://docs.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes)and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - String - - String - - - None - - - RetentionComplianceAction - - The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: - - Delete - - Keep - - KeepAndDelete - - String - - String - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - You can't use this parameter for Teams retention rules. - - HoldDurationHint - - HoldDurationHint - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-retentioncompliancerule - - - - - - Set-SafeAttachmentPolicy - Set - SafeAttachmentPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-SafeAttachmentPolicy - - 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 - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - Action - - The Action parameter specifies the action for the safe attachment policy. Valid values are: - - Allow: Attachments aren't scanned by safe attachment policies. - - Block: Block the email message that contains the malware attachment. This is the default value. - - Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. - - DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see How Dynamic Delivery works (https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). - The results of all actions are available in message trace. - - SafeAttachmentAction - - SafeAttachmentAction - - - None - - - ActionOnError - - The ActionOnError parameter specifies the error handling option for safe attachment 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. This is the default value. - - $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. - - Boolean - - Boolean - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enable - - This parameter isn't used. To enable or disable a safe attachment policy, use the Enabled parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RedirectAddress - - The RedirectAddress parameter specifies the email address where detected malware attachments are sent when the Redirect parameter is set to the value $true. - - SmtpAddress - - SmtpAddress - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - Action - - The Action parameter specifies the action for the safe attachment policy. Valid values are: - - Allow: Attachments aren't scanned by safe attachment policies. - - Block: Block the email message that contains the malware attachment. This is the default value. - - Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. - - DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see How Dynamic Delivery works (https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). - The results of all actions are available in message trace. - - SafeAttachmentAction - - SafeAttachmentAction - - - None - - - ActionOnError - - The ActionOnError parameter specifies the error handling option for safe attachment 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. This is the default value. - - $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. - - Boolean - - Boolean - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enable - - This parameter isn't used. To enable or disable a safe attachment policy, use the Enabled parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - RedirectAddress - - The RedirectAddress parameter specifies the email address where detected malware attachments are sent when the Redirect parameter is set to the value $true. - - SmtpAddress - - SmtpAddress - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-SafeAttachmentsPolicy -Identity "Engineering Block Attachments" -Redirect $true -RedirectAddress admin@contoso.com - - This example modifies the existing safe attachment policy named Engineering Block Attachments to redirect detected malware attachments to admin@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-safeattachmentpolicy - - - - - - Set-SafeAttachmentRule - Set - SafeAttachmentRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see Safe Attachments in Defender for Office 365 (https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-SafeAttachmentRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - Name - - The Name parameter specifies a unique name for the safe attachment rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - Name - - The Name parameter specifies a unique name for the safe attachment rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - SafeAttachmentPolicyIdParameter - - SafeAttachmentPolicyIdParameter - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-safeattachmentrule - - - - - - Set-SafeLinksPolicy - Set - SafeLinksPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-SafeLinksPolicy - - 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 - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AllowClickThrough - - The AllowClickThrough parameter specifies whether to allow users to click through to the original URL on warning pages. Valid values are: - - $true: The user is allowed to click through to the original URL. This is the default value. - - $false: The user isn't allowed to click through to the original URL. - - Boolean - - Boolean - - - True - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DeliverMessageAfterScan - - The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: - - $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. - - $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. - - Boolean - - Boolean - - - False - - - DisableUrlRewrite - - The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: - - $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). Typically, we don't recommend using this value. - - $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This is the default value. - - Boolean - - Boolean - - - 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://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EnableForInternalSenders - - The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: - - $true: The policy is applied to internal and external senders. - - $false: The policy is applied only to external senders. This is the default value. - - Boolean - - Boolean - - - False - - - EnableOrganizationBranding - - The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in Customize the Microsoft 365 theme for your organization(https://docs.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. - - $false: Organization branding is not displayed on Safe Links warning and notification pages. - - Boolean - - Boolean - - - None - - - EnableSafeLinksForEmail - - The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: - - $true: Safe Links is enabled for email. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - - $false: Safe Links isn't enabled for email. This is the default value. - - Boolean - - Boolean - - - False - - - EnableSafeLinksForTeams - - Note : As of March 2020, this parameter is in Preview is available only for members of the Microsoft Teams Technology Adoption Program (TAP). - The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: - - $true: Safe Links is enabled for Teams. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - - $false: Safe Links isn't enabled for Teams. This is the default value. - - Boolean - - Boolean - - - 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 in email messages, including links that point to files, is enabled. - - $false: Real-time scanning of clicked links in email messages, including links that point to files, is disabled. This is the default value. - - Boolean - - Boolean - - - False - - - TrackClicks - - The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links in email messages. Valid values are: - - $true: User clicks in email messages are tracked. This is the default value. - - $false: User clicks in email messages aren't tracked. - - Boolean - - Boolean - - - True - - - 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. - - Boolean - - Boolean - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - AdminDisplayName - - The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - AllowClickThrough - - The AllowClickThrough parameter specifies whether to allow users to click through to the original URL on warning pages. Valid values are: - - $true: The user is allowed to click through to the original URL.This is the default value. - - $false: The user isn't allowed to click through to the original URL. - - Boolean - - Boolean - - - True - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - DeliverMessageAfterScan - - The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: - - $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. - - $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. - - Boolean - - Boolean - - - False - - - DisableUrlRewrite - - The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: - - $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). Typically, we don't recommend using this value. - - $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This is the default value. - - Boolean - - Boolean - - - 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://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - EnableForInternalSenders - - The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: - - $true: The policy is applied to internal and external senders. - - $false: The policy is applied only to external senders. This is the default value. - - Boolean - - Boolean - - - False - - - EnableOrganizationBranding - - The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: - - $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in Customize the Microsoft 365 theme for your organization(https://docs.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. - - $false: Organization branding is not displayed on Safe Links warning and notification pages. - - Boolean - - Boolean - - - None - - - EnableSafeLinksForEmail - - The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: - - $true: Safe Links is enabled for email. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - - $false: Safe Links isn't enabled for email. This is the default value. - - Boolean - - Boolean - - - False - - - EnableSafeLinksForTeams - - Note : As of March 2020, this parameter is in Preview is available only for members of the Microsoft Teams Technology Adoption Program (TAP). - The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: - - $true: Safe Links is enabled for Teams. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. - - $false: Safe Links isn't enabled for Teams. This is the default value. - - Boolean - - Boolean - - - 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 in email messages, including links that point to files, is enabled. - - $false: Real-time scanning of clicked links in email messages, including links that point to files, is disabled. This is the default value. - - Boolean - - Boolean - - - False - - - TrackClicks - - The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links in email messages. Valid values are: - - $true: User clicks in email messages are tracked. This is the default value. - - $false: User clicks in email messages aren't tracked. - - Boolean - - Boolean - - - True - - - 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. - - Boolean - - Boolean - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-SafeLinksPolicy -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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-safelinkspolicy - - - - - - Set-SafeLinksRule - Set - SafeLinksRule - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-SafeLinksRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - Name - - The Name parameter specifies a unique name for the Safe Links rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - Name - - The Name parameter specifies a unique name for the Safe Links rule. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - SafeLinksPolicyIdParameter - - SafeLinksPolicyIdParameter - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-safelinksrule - - - - - - Set-SupervisoryReviewPolicyV2 - Set - SupervisoryReviewPolicyV2 - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-SupervisoryReviewPolicyV2 cmdlet to modify supervisory review policies in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-SupervisoryReviewPolicyV2 - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - String[] - - String[] - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - String[] - - String[] - - - None - - - RetentionPeriodInDays - - The RetentionPeriodInDays parameter specifies the number of days that the messages will be retained for review. - - Int32 - - Int32 - - - None - - - 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. - - String[] - - String[] - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - PolicyIdParameter - - PolicyIdParameter - - - None - - - 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. - - String[] - - String[] - - - None - - - 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". - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String[] - - String[] - - - None - - - RetentionPeriodInDays - - The RetentionPeriodInDays parameter specifies the number of days that the messages will be retained for review. - - Int32 - - Int32 - - - None - - - 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. - - String[] - - String[] - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-supervisoryreviewpolicyv2 - - - - - - Set-SupervisoryReviewRule - Set - SupervisoryReviewRule - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-SupervisoryReviewRule - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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))"`. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - ComplianceRuleIdParameter - - ComplianceRuleIdParameter - - - None - - - 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))"`. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-supervisoryreviewrule - - - - - - Set-SweepRule - Set - SweepRule - - This cmdlet is available in 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-SweepRule cmdlet to modify Sweep rules in mailboxes. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-SweepRule - - Identity - - 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: `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. - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DestinationFolder - - The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. - For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - Enabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - KeepForDays - - The KeepForDays parameter specifies an action for the Sweep rule that specifies the number of days to keep messages that match the conditions of the rule. After the number of days have passed, the messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). - You can't use this parameter with the KeepLatest parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. - - Int32 - - Int32 - - - None - - - KeepLatest - - The KeepLatest parameter specifies an action for the Sweep rule that specifies the number of messages to keep that match the conditions of the rule. After the number of messages is exceeded, the oldest messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). - You can't use this parameter with the KeepForDays parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. - - Int32 - - Int32 - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Name - - The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - Provider - - The Provider parameter specifies the provider for the Sweep rule. If the value contains spaces, enclose the value in quotation marks. - For Sweep rules that you create in Outlook on the web, the default value is Exchange16. - - String - - String - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - For external senders, use their email address. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - SourceFolder - - The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. - For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - SystemCategory - - 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 - - SystemCategoryType - - SystemCategoryType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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: `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. - - SweepRuleIdParameter - - SweepRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DestinationFolder - - The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. - For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - Enabled - - This parameter is reserved for internal Microsoft use. - - Boolean - - Boolean - - - None - - - KeepForDays - - The KeepForDays parameter specifies an action for the Sweep rule that specifies the number of days to keep messages that match the conditions of the rule. After the number of days have passed, the messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). - You can't use this parameter with the KeepLatest parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. - - Int32 - - Int32 - - - None - - - KeepLatest - - The KeepLatest parameter specifies an action for the Sweep rule that specifies the number of messages to keep that match the conditions of the rule. After the number of messages is exceeded, the oldest messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder). - You can't use this parameter with the KeepForDays parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value. - - Int32 - - Int32 - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Name - - The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - Provider - - The Provider parameter specifies the provider for the Sweep rule. If the value contains spaces, enclose the value in quotation marks. - For Sweep rules that you create in Outlook on the web, the default value is Exchange16. - - String - - String - - - None - - - 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: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - For external senders, use their email address. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - SourceFolder - - The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is `MailboxID:\ParentFolder[\SubFolder]`. - For the value of `MailboxID`, you can use any value that uniquely identifies the mailbox. For example: - - 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`. - - MailboxFolderIdParameter - - MailboxFolderIdParameter - - - None - - - SystemCategory - - 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 - - SystemCategoryType - - SystemCategoryType - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-SweepRule -Identity x2hlsdpGmUifjFgxxGIOJw== -KeepForDays 15 - - This example modifies the existing rule that has the rule ID value x2hlsdpGmUifjFgxxGIOJw== with the specified value. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-sweeprule - - - - - - Set-TenantAllowBlockListItems - Set - TenantAllowBlockListItems - - Note : The features described in this topic are in Preview, are subject to change, and are not available in all organizations. - 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 Security & Compliance Center. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-TenantAllowBlockListItems - - Action - - The Action parameter specifies the action type for the entry. Valid values are: - - Allow - - Block - - TenantAllowBlockList.ItemAction - - TenantAllowBlockList.ItemAction - - - None - - - 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, `"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/2020 9:30 AM").ToUniversalTime()`. For more information, see Get-Date (https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - You can't use this parameter with the NoExpiration switch. - - DateTime - - DateTime - - - None - - - Ids - - The Ids parameter specifies the entry that you want to modify. To find this value, use the Get-TenantAllowBlockListItems cmdlet and the Entry property value (a URL or a file hash). - An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. - You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - ListType - - The ListType parameter specifies the type of entry. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - - Set-TenantAllowBlockListItems - - Action - - The Action parameter specifies the action type for the entry. Valid values are: - - Allow - - Block - - TenantAllowBlockList.ItemAction - - TenantAllowBlockList.ItemAction - - - None - - - Ids - - The Ids parameter specifies the entry that you want to modify. To find this value, use the Get-TenantAllowBlockListItems cmdlet and the Entry property value (a URL or a file hash). - An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. - You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - ListType - - The ListType parameter specifies the type of entry. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - NoExpiration - - The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. - You can't use this switch with the ExpirationDate parameter. - - - SwitchParameter - - - False - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - - - - Action - - The Action parameter specifies the action type for the entry. Valid values are: - - Allow - - Block - - TenantAllowBlockList.ItemAction - - TenantAllowBlockList.ItemAction - - - None - - - 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, `"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/2020 9:30 AM").ToUniversalTime()`. For more information, see Get-Date (https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). - You can't use this parameter with the NoExpiration switch. - - DateTime - - DateTime - - - None - - - Ids - - The Ids parameter specifies the entry that you want to modify. To find this value, use the Get-TenantAllowBlockListItems cmdlet and the Entry property value (a URL or a file hash). - An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. - You can specify multiple values separated by commas. - - String[] - - String[] - - - None - - - ListType - - The ListType parameter specifies the type of entry. Valid values are: - - FileHash - - Url - - ListType - - ListType - - - None - - - NoExpiration - - The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. - You can't use this switch with the ExpirationDate parameter. - - SwitchParameter - - SwitchParameter - - - False - - - Notes - - The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-TenantAllowBlockListItems -ListType Url -Ids "RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSRAAAA" -ExpirationDate (Get-Date "5/30/2020 9:30 AM").ToUniversalTime() - - This example changes the expiration date of the specified entry. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-tenantallowblocklistitems - - - - - - Set-TransportRule - Set - TransportRule - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-TransportRule - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 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. - - ADAttribute - - ADAttribute - - - None - - - 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 - - Evaluation - - Evaluation - - - None - - - 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. - - AddedRecipientType - - AddedRecipientType - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - DisclaimerFallbackAction - - DisclaimerFallbackAction - - - None - - - 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 at the beginning of the message body. - - If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. - - DisclaimerLocation - - DisclaimerLocation - - - None - - - 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). - - DisclaimerText - - DisclaimerText - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - 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://docs.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 2013 (https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). - - Boolean - - Boolean - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DlpPolicy - - The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see Data loss prevention in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). - - String - - String - - - None - - - 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 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. - - ADAttribute - - ADAttribute - - - None - - - 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 - - Evaluation - - Evaluation - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 2013 (https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). - - Boolean - - Boolean - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - 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). - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - FromUserScope - - FromUserScope - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - EvaluatedUser - - EvaluatedUser - - - None - - - ExceptIfMessageContainsAllDataClassifications - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Hashtable[] - - Hashtable[] - - - None - - - 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 in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). - - Hashtable[] - - Hashtable[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 on the web 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: Moderation request messages sent to moderators. - - ReadReceipt: Read receipts. - - MessageType - - MessageType - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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$'. - - Word[] - - Word[] - - - None - - - ExceptIfRecipientInSenderList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - ExceptIfSenderInRecipientList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ManagementRelationship - - ManagementRelationship - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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) - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - ToUserScope - - ToUserScope - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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 - - Importance - - Importance - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - 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). - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - FromUserScope - - FromUserScope - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - An incident report is generated for messages that violate a DLP policy in your organization. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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%% - - DisclaimerText - - DisclaimerText - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - IncidentReportContent[] - - IncidentReportContent[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - EvaluatedUser - - EvaluatedUser - - - None - - - MessageContainsAllDataClassifications - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Hashtable[] - - Hashtable[] - - - None - - - 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 in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). - You can specify the notification options by using the NotifySender parameter. - - Hashtable[] - - Hashtable[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 on the web 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: Moderation request messages sent to moderators. - - ReadReceipt: Read receipts. - - MessageType - - MessageType - - - None - - - 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. - - RuleMode - - RuleMode - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - NotifySenderType - - NotifySenderType - - - None - - - 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. - - SubjectPrefix - - SubjectPrefix - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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$'. - - Word[] - - Word[] - - - None - - - RecipientInSenderList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 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. - - RejectEnhancedStatus - - RejectEnhancedStatus - - - None - - - 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 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. - - RejectText - - RejectText - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - RuleErrorAction - - RuleErrorAction - - - None - - - 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. - - RuleSubType - - RuleSubType - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - SenderAddressLocation - - SenderAddressLocation - - - None - - - 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). - - Word[] - - Word[] - - - None - - - SenderInRecipientList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ManagementRelationship - - ManagementRelationship - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - ToUserScope - - ToUserScope - - - None - - - 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. - - String - - String - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - HeaderValue - - HeaderValue - - - None - - - 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. - - SclValue - - SclValue - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - Importance - - Importance - - - None - - - - - - 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 - - RuleIdParameter - - RuleIdParameter - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 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. - - ADAttribute - - ADAttribute - - - None - - - 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 - - Evaluation - - Evaluation - - - None - - - 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. - - AddedRecipientType - - AddedRecipientType - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - DisclaimerFallbackAction - - DisclaimerFallbackAction - - - None - - - 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 at the beginning of the message body. - - If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. - - DisclaimerLocation - - DisclaimerLocation - - - None - - - 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). - - DisclaimerText - - DisclaimerText - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - 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://docs.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). - - RmsTemplateIdParameter - - RmsTemplateIdParameter - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 2013 (https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). - - Boolean - - Boolean - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - DlpPolicy - - The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see Data loss prevention in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). - - String - - String - - - None - - - 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 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. - - ADAttribute - - ADAttribute - - - None - - - 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 - - Evaluation - - Evaluation - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 2013 (https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). - - Boolean - - Boolean - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - 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). - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - FromUserScope - - FromUserScope - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - EvaluatedUser - - EvaluatedUser - - - None - - - ExceptIfMessageContainsAllDataClassifications - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Hashtable[] - - Hashtable[] - - - None - - - 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 in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). - - Hashtable[] - - Hashtable[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 on the web 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: Moderation request messages sent to moderators. - - ReadReceipt: Read receipts. - - MessageType - - MessageType - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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$'. - - Word[] - - Word[] - - - None - - - ExceptIfRecipientInSenderList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - ExceptIfSenderInRecipientList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ManagementRelationship - - ManagementRelationship - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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) - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - ToUserScope - - ToUserScope - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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 - - Importance - - Importance - - - None - - - 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". - - DateTime - - DateTime - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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). - - Word[] - - Word[] - - - None - - - 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). - - Pattern[] - - Pattern[] - - - None - - - 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 - - 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). - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - FromUserScope - - FromUserScope - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Email address - - GUID - - An incident report is generated for messages that violate a DLP policy in your organization. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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%% - - DisclaimerText - - DisclaimerText - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - IncidentReportContent[] - - IncidentReportContent[] - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - EvaluatedUser - - EvaluatedUser - - - None - - - MessageContainsAllDataClassifications - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Hashtable[] - - Hashtable[] - - - None - - - 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 in Exchange Server (https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). - You can specify the notification options by using the NotifySender parameter. - - Hashtable[] - - Hashtable[] - - - None - - - 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. - - ByteQuantifiedSize - - ByteQuantifiedSize - - - None - - - 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 on the web 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: Moderation request messages sent to moderators. - - ReadReceipt: Read receipts. - - MessageType - - MessageType - - - None - - - 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. - - RuleMode - - RuleMode - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - NotifySenderType - - NotifySenderType - - - None - - - 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. - - SubjectPrefix - - SubjectPrefix - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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. - - Pattern[] - - Pattern[] - - - None - - - 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$'. - - Word[] - - Word[] - - - None - - - RecipientInSenderList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 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. - - RejectEnhancedStatus - - RejectEnhancedStatus - - - None - - - 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 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. - - RejectText - - RejectText - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - RuleErrorAction - - RuleErrorAction - - - None - - - 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. - - RuleSubType - - RuleSubType - - - None - - - 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 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. - - Word[] - - Word[] - - - None - - - 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 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. - - Pattern[] - - Pattern[] - - - None - - - 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 - - SenderAddressLocation - - SenderAddressLocation - - - None - - - 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). - - Word[] - - Word[] - - - None - - - SenderInRecipientList - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - Word[] - - Word[] - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - ManagementRelationship - - ManagementRelationship - - - None - - - 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 - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 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. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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. - - ToUserScope - - ToUserScope - - - None - - - 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. - - String - - String - - - None - - - 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. - - HeaderName - - HeaderName - - - None - - - 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. - - HeaderValue - - HeaderValue - - - None - - - 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. - - SclValue - - SclValue - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - 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. - - Word[] - - Word[] - - - None - - - 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"`. - - Pattern[] - - Pattern[] - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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 - - Importance - - Importance - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-transportrule - - - - - - Set-UnifiedAuditLogRetentionPolicy - Set - UnifiedAuditLogRetentionPolicy - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Set-UnifiedAuditLogRetentionPolicy cmdlet to modify audit log retention policies in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see Manage audit log retention policies (https://docs.microsoft.com/microsoft-365/compliance/audit-log-retention-policies). - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Set-UnifiedAuditLogRetentionPolicy - - 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 - - Distingished name (DN) - - GUID - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Priority - - The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a higher priority, the value 10000 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 8 existing policies: - - Valid priority values for the existing 8 policies are from 7 through 0. - - Valid priority values for a new policy (the 9th policy) are from 8 through 0. - - You must use a unique priority value when modifying audit log retention policies. This parameter is required when modifying an audit log retention policy. - - Int32 - - Int32 - - - None - - - 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. - - - ThreeMonths - SixMonths - NineMonths - TwelveMonths - TenYears - - UnifiedAuditLogRetentionDuration - - UnifiedAuditLogRetentionDuration - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecordTypes - - The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can specify multiple values separated by commas. The values you specify will overwrite any existing entries. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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 - - Distingished name (DN) - - GUID - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Priority - - The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a higher priority, the value 10000 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 8 existing policies: - - Valid priority values for the existing 8 policies are from 7 through 0. - - Valid priority values for a new policy (the 9th policy) are from 8 through 0. - - You must use a unique priority value when modifying audit log retention policies. This parameter is required when modifying an audit log retention policy. - - Int32 - - Int32 - - - None - - - 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. - - UnifiedAuditLogRetentionDuration - - UnifiedAuditLogRetentionDuration - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - RecordTypes - - The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see AuditLogRecordType (https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - You can specify multiple values separated by commas. The values you specify will overwrite any existing entries. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-UnifiedAuditLogRetentionPolicy -Identity "eDiscovery audit retention" -RecordTypes Discovery,AeD -UserIds admin@contoso.onmicrosoft.com -RetentionDuration SixMonths -Priority 100 - - This example adds the AeD (for Advanced eDiscovery 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-unifiedauditlogretentionpolicy - - - - - - Start-InformationBarrierPoliciesApplication - Start - InformationBarrierPoliciesApplication - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Start-InformationBarrierPoliciesApplication cmdlet to apply active information barrier policies in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Start-InformationBarrierPoliciesApplication - - Identity - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - Identity - - This parameter is reserved for internal Microsoft use. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Start-InformationBarrierPoliciesApplication - - This applies all active information barrier policies. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - New-InformationBarrierPolicy - https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy - - - - - - Stop-InformationBarrierPoliciesApplication - Stop - InformationBarrierPoliciesApplication - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Stop-InformationBarrierPoliciesApplication cmdlet to stop the process of applying information barrier policies in the Security & Compliance Center. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Stop-InformationBarrierPoliciesApplication - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - - SwitchParameter - - - False - - - - - - 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. - - PolicyIdParameter - - PolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication - - - Define policies for information barriers - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies - - - Edit (or remove) information barrier policies - https://docs.microsoft.com/microsoft-365/compliance/information-barriers-edit-segments-policies - - - - - - Validate-OutboundConnector - Validate - OutboundConnector - - 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 : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Validate-OutboundConnector - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - OutboundConnectorIdParameter - - OutboundConnectorIdParameter - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/validate-outboundconnector - - - - - - Validate-RetentionRuleQuery - Validate - RetentionRuleQuery - - This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see Security & Compliance Center PowerShell (https://docs.microsoft.com/powershell/exchange/scc-powershell). - Use the Validate-RetentionRuleQuery cmdlet to validate the Keyword Query Language (KQL) content search filters for retention rules. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in the Security & Compliance Center (https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - - - - Validate-RetentionRuleQuery - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - - - - 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 (KQL) syntax reference (https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Validate-RetentionRuleQuery -KqlQueryString 'from:"Ann Beebe" AND subject:northwind' - - This example validates the specified KQL content search filter. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/validate-retentionrulequery - - - - diff --git a/ExchangeOnlineHelp/Microsoft.Exchange.WebClient-Help.xml b/ExchangeOnlineHelp/Microsoft.Exchange.WebClient-Help.xml deleted file mode 100644 index f18d4f17ae33..000000000000 --- a/ExchangeOnlineHelp/Microsoft.Exchange.WebClient-Help.xml +++ /dev/null @@ -1,22032 +0,0 @@ - - - - - Add-PublicFolderClientPermission - Add - PublicFolderClientPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Add-PublicFolderClientPermission - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - User - - The User parameter specifies the user principal name (UPN), domain\user, or alias of the user for whom rights are being added. - - PublicFolderUserIdParameter - - PublicFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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 - - MultiValuedProperty - - MultiValuedProperty - - - None - - - User - - The User parameter specifies the user principal name (UPN), domain\user, or alias of the user for whom rights are being added. - - PublicFolderUserIdParameter - - PublicFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/add-publicfolderclientpermission - - - - - - Clear-TextMessagingAccount - Clear - TextMessagingAccount - - This cmdlet is 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Clear-TextMessagingAccount cmdlet clears all of a user's text messaging settings, including communication and notification settings. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Clear-TextMessagingAccount - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Clear-TextMessagingAccount -Identity tony@contoso.com - - This example clears the text messaging account settings and notification settings from Tony's mailbox. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/clear-textmessagingaccount - - - - - - Compare-TextMessagingVerificationCode - Compare - TextMessagingVerificationCode - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Compare-TextMessagingVerificationCode - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - VerificationCode - - The VerificationCode parameter contains the verification code that the user specified. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - VerificationCode - - The VerificationCode parameter contains the verification code that the user specified. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/compare-textmessagingverificationcode - - - - - - Disable-App - Disable - App - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Disable-App cmdlet requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). - For more information, see Manage user access to add-ins for Outlook in Exchange Server (https://docs.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://docs.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-App - - Identity - - The Identity parameter specifies the GUID of the app. - - AppIdParameter - - AppIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the GUID of the app. - - AppIdParameter - - AppIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-App -Identity 7a774f0c-7a6f-11e0-85ad-07fb4824019b -Mailbox Tony - - This example disables the Bing Maps app for user Tony. - - - - -------------------------- Example 2 -------------------------- - Disable-App -Identity <GUID for FinanceTestApp> -Mailbox Tony - - This example disables the administrator-installed app FinanceTestApp for user Tony. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-app - - - - - - Disable-MailPublicFolder - Disable - MailPublicFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Disable-MailPublicFolder - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 Identity so that only the public folder name or GUID is supplied. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Disable-MailPublicFolder -Identity "\Help Desk" - - This example mail-disables the public folder Help Desk. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/disable-mailpublicfolder - - - - - - Enable-App - Enable - App - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Enable-App cmdlet requires that the specified app has already been installed (for example, that it has been installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). - For more information, see Manage user access to add-ins for Outlook in Exchange Server (https://docs.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://docs.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-App - - Identity - - The Identity parameter specifies the GUID of the app. - - AppIdParameter - - AppIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Mailbox - - The Mailbox parameter specifies the 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the GUID of the app. - - AppIdParameter - - AppIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Mailbox - - The Mailbox parameter specifies the 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Enable-App -Identity 7a774f0c-7a6f-11e0-85ad-07fb4824019b -Mailbox Tony - - This example enables the default Bing Maps app installed for user Tony. - - - - -------------------------- Example 2 -------------------------- - Enable-App -Identity <GUID for FinanceTestApp> -Mailbox Tony - - This example enables the administrator-installed app FinanceTestApp for user Tony. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-app - - - - - - Enable-MailPublicFolder - Enable - MailPublicFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Enable-MailPublicFolder - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - OverrideRecipientQuotas - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - OverrideRecipientQuotas - - This parameter is available only in the cloud-based service. - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/enable-mailpublicfolder - - - - - - Get-App - Get - App - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-App cmdlet returns information about all installed apps or the details of a specific installed app. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-App - - 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. - - AppIdParameter - - AppIdParameter - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - AppIdParameter - - AppIdParameter - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-app - - - - - - Get-CalendarNotification - Get - CalendarNotification - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CalendarNotification - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - ReadFromDomainController - - The ReadFromDomainController parameter specifies whether the command should return data from the domain controller. - - - SwitchParameter - - - False - - - ResultSize - - The ResultSize parameter specifies the amount of data returned. - - Unlimited - - Unlimited - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - ReadFromDomainController - - The ReadFromDomainController parameter specifies whether the command should return data from the domain controller. - - SwitchParameter - - SwitchParameter - - - False - - - ResultSize - - The ResultSize parameter specifies the amount of data returned. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-calendarnotification - - - - - - Get-CASMailbox - Get - CASMailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet returns a variety of client access settings for one or more mailboxes. These settings include options for Outlook on the web, Exchange ActiveSync, POP3, and IMAP4. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-CASMailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - ActiveSyncSuppressReadReceipt - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-CASMailbox - - 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. - - - SwitchParameter - - - False - - - ActiveSyncSuppressReadReceipt - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ActiveSyncSuppressReadReceipt - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 - - OrganizationalUnitIdParameter - - OrganizationalUnitIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - RecipientTypeDetails[] - - RecipientTypeDetails[] - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- Example 4 -------------------------- - Get-CASMailbox -RecipientTypeDetails SharedMailbox | Select * - - In Exchange Online, this example filters the cmdlet output to only include shared mailboxes. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-casmailbox - - - - - - Get-ClientAccessRule - Get - ClientAccessRule - - This cmdlet is available or functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Get-ClientAccessRule cmdlet to view client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-ClientAccessRule - - 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 - - ClientAccessRuleIdParameter - - ClientAccessRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 - - ClientAccessRuleIdParameter - - ClientAccessRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-clientaccessrule - - - - - - Get-DataEncryptionPolicy - Get - DataEncryptionPolicy - - This cmdlet is available only in the cloud-based service. - Use the Get-DataEncryptionPolicy cmdlet to view data encryption policies in Exchange Online. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Data encryption policy cmdlets are the Exchange Online part of service encryption with Customer Key in Microsoft 365. 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-DataEncryptionPolicy - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-dataencryptionpolicy - - - - - - Get-FailedContentIndexDocuments - Get - FailedContentIndexDocuments - - Although this cmdlet is available in on-premises Exchange and in the cloud-based service, it only works in Exchange Server 2016 or earlier. - Use the Get-FailedContentIndexDocuments cmdlet to retrieve a list of documents for a mailbox, mailbox database, or Mailbox server that couldn't be indexed by Exchange Search. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Get-FailedContentIndexDocuments cmdlet returns a list of documents that couldn't be indexed. The most common reason is that there was no filter available for that document type or there was an attachment within the document. For example, the PDF filter isn't available by default. If an email message contains a PDF document, because there is no PDF filter, the document is marked as failed content indexing. - After a new filter is installed, only new messages with attachments of the type for which the filter is installed are indexed. If you want to index older messages for the document type, the mailbox has to be moved. - The cmdlet output provides details about items in a mailbox that couldn't be indexed, including an error code and the reason for failure. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-FailedContentIndexDocuments - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - 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. - - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - ErrorCode - - The ErrorCode parameter allows you to retrieve documents that failed indexing with a specific error code. You can use the cmdlet without this parameter to list all failed documents for a mailbox, a mailbox database or a Mailbox server. The output includes the error codes and reason for failure. If required, you can then restrict the output to a specific error code from the results. - - Int32 - - Int32 - - - None - - - FailureMode - - 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. - - FailureMode - - FailureMode - - - None - - - ResultSize - - This parameter is reserved for internal Microsoft use. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Get-FailedContentIndexDocuments - - MailboxDatabase - - The MailboxDatabase parameter specifies the database from which to get the mailbox. You can use any value that uniquely identifies the database. For example: - - Name - - Distinguished name (DN) - - GUID - - DatabaseIdParameter - - DatabaseIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - ErrorCode - - The ErrorCode parameter allows you to retrieve documents that failed indexing with a specific error code. You can use the cmdlet without this parameter to list all failed documents for a mailbox, a mailbox database or a Mailbox server. The output includes the error codes and reason for failure. If required, you can then restrict the output to a specific error code from the results. - - Int32 - - Int32 - - - None - - - FailureMode - - 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. - - FailureMode - - FailureMode - - - None - - - ResultSize - - This parameter is reserved for internal Microsoft use. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Get-FailedContentIndexDocuments - - Server - - The Server parameter specifies a Mailbox server. You can use the following values: - - Name - - GUID - - DN - - ServerIdParameter - - ServerIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - EndDate - - The EndDate parameter specifies the end date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - ErrorCode - - The ErrorCode parameter allows you to retrieve documents that failed indexing with a specific error code. You can use the cmdlet without this parameter to list all failed documents for a mailbox, a mailbox database or a Mailbox server. The output includes the error codes and reason for failure. If required, you can then restrict the output to a specific error code from the results. - - Int32 - - Int32 - - - None - - - FailureMode - - 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. - - FailureMode - - FailureMode - - - None - - - ResultSize - - This parameter is reserved for internal Microsoft use. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - - Name - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - MailboxDatabase - - The MailboxDatabase parameter specifies the database from which to get the mailbox. You can use any value that uniquely identifies the database. For example: - - Name - - Distinguished name (DN) - - GUID - - DatabaseIdParameter - - DatabaseIdParameter - - - None - - - Server - - The Server parameter specifies a Mailbox server. You can use the following values: - - Name - - GUID - - DN - - ServerIdParameter - - ServerIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - - Fqdn - - Fqdn - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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". - - DateTime - - DateTime - - - None - - - ErrorCode - - The ErrorCode parameter allows you to retrieve documents that failed indexing with a specific error code. You can use the cmdlet without this parameter to list all failed documents for a mailbox, a mailbox database or a Mailbox server. The output includes the error codes and reason for failure. If required, you can then restrict the output to a specific error code from the results. - - Int32 - - Int32 - - - None - - - FailureMode - - 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. - - FailureMode - - FailureMode - - - None - - - ResultSize - - This parameter is reserved for internal Microsoft use. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - DateTime - - DateTime - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-failedcontentindexdocuments - - - - - - Get-M365DataAtRestEncryptionPolicy - Get - M365DataAtRestEncryptionPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - M365 data-at-rest encryption policy cmdlets are accessible to compliance administrator role as part of the Exchange Online infrastructure. For more information, see Overview of M365 Customer Key at the tenant level (https://docs.microsoft.com/microsoft-365/compliance/customer-key-tenant-level#get-policy-details). - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-M365DataAtRestEncryptionPolicy - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - - - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-M365DataAtRestEncryptionPolicy - - This example returns a summary list of all Microsoft 365 data-at-rest encryption policies. - - - - -------------------------- Example 2 -------------------------- - Get-M365DataAtRestEncryptionPolicy -Identity "Contoso Corporate" | Format-List - - This example returns detailed information about the policy named Contoso Corporate. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicy - - - - - - Get-M365DataAtRestEncryptionPolicyAssignment - Get - M365DataAtRestEncryptionPolicyAssignment - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - This cmdlet lists the Microsoft 365 data-at-rest encryption policy that's currently assigned to the tenant. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-M365DataAtRestEncryptionPolicyAssignment - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-M365DataAtRestEncryptionPolicyAssignment - - This example returns a summary list of all Microsoft 365 data-at-rest encryption policy assignments. - - - - -------------------------- Example 2 -------------------------- - Get-M365DataAtRestEncryptionPolicyAssignment | Format-List - - This example returns detailed information for all Microsoft 365 data-at-rest encryption policy assignments. - - - - ----------------------- CommonParameters ----------------------- - - - - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicyassignment - - - - - - Get-MailPublicFolder - Get - MailPublicFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-MailPublicFolder - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - Get-MailPublicFolder - - 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. - - MailPublicFolderIdParameter - - MailPublicFolderIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - 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 - - String - - String - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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://docs.microsoft.com/powershell/exchange/filter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - - String - - String - - - None - - - 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. - - MailPublicFolderIdParameter - - MailPublicFolderIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - 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 - - String - - String - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-mailpublicfolder - - - - - - Get-Notification - Get - Notification - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-Notification - - 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. - - EwsStoreObjectIdParameter - - EwsStoreObjectIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - Get-Notification - - ProcessType - - The ProcessType parameter filters the results by the type of notification event. Valid values are: - - CertExpiry - - ExportPST - - ImportPST - - MailboxRestore - - Migration - - AsyncOperationType - - AsyncOperationType - - - None - - - - Get-Notification - - ProcessType - - The ProcessType parameter filters the results by the type of notification event. Valid values are: - - CertExpiry - - ExportPST - - ImportPST - - MailboxRestore - - Migration - - AsyncOperationType - - AsyncOperationType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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. - - - SwitchParameter - - - 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. - - EwsStoreObjectIdParameter - - EwsStoreObjectIdParameter - - - None - - - ProcessType - - The ProcessType parameter filters the results by the type of notification event. Valid values are: - - CertExpiry - - ExportPST - - ImportPST - - MailboxRestore - - Migration - - AsyncOperationType - - AsyncOperationType - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - StartDate - - The StartDate parameter specifies the start date of the date range. - Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - - ExDateTime - - ExDateTime - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-notification - - - - - - Get-OMEConfiguration - Get - OMEConfiguration - - This cmdlet is available only in the cloud-based service. - Use the Get-OMEConfiguration cmdlet to view Microsoft 365 Message Encryption (OME) configurations. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OMEConfiguration - - Identity - - The Identity parameter specifies the OME configuration that you want to get. The default OME configuration has the Identity value "OME Configuration". - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - - - - Identity - - The Identity parameter specifies the OME configuration that you want to get. The default OME configuration has the Identity value "OME Configuration". - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-OMEConfiguration - - This example returns a summary list of all OME configurations in the organization. - - - - -------------------------- Example 2 -------------------------- - Get-OMEConfiguration | Format-List - - This example returns detailed information for all OME configurations in the organization. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-omeconfiguration - - - - - - Get-OMEMessageStatus - Get - OMEMessageStatus - - This cmdlet is available only in the cloud-based service. - Use the Get-OMEMessageStatus cmdlet to view the Microsoft 365 Message Encryption (OME) revocation status for a specific message. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If encryption for the message was successfully revoked, the command will return the message: `The encrypted email with the subject "<subject>" and Message ID "<messageId>" was successfully revoked`. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OMEMessageStatus - - 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, "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>"). - You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Security & Compliance Center. - - String - - String - - - None - - - - - - 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, "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>"). - You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Security & Compliance Center. - - String - - String - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-OMEMessageStatus -MessageId "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>" - - This example returns the encryption revocation status for the specified message. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-omemessagestatus - - - - - - Get-OwaMailboxPolicy - Get - OwaMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-OwaMailboxPolicy - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-owamailboxpolicy - - - - - - Get-PublicFolder - Get - PublicFolder - - This cmdlet is available in 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-PublicFolder cmdlet to retrieve the attributes of a public folder or a set of public folders. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PublicFolder - - 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"`. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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. - You can't use this switch with the Recurse or LostAndFound switches. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - ResultSize - - The ResultSize parameter specifies the maximum number of results to return. The default maximum is 10,000. For no limit on the returned results, set this parameter to Unlimited. This parameter can only be passed in combination with the Recurse or GetChildren parameters. - - Unlimited - - Unlimited - - - None - - - - Get-PublicFolder - - 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"`. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - Recurse - - The Recurse switch specifies whether to return the specified public folder and all its children. You don't need to specify a value with this switch. - You can't use this switch with the GetChildren or LostAndFound switches. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - ResultSize - - The ResultSize parameter specifies the maximum number of results to return. The default maximum is 10,000. For no limit on the returned results, set this parameter to Unlimited. This parameter can only be passed in combination with the Recurse or GetChildren parameters. - - Unlimited - - Unlimited - - - None - - - - Get-PublicFolder - - 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"`. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - - Get-PublicFolder - - 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. - The LOST_AND_FOUND folder holds missing folders that are recreated by the public folder hierarchy reconciliation process when the folder exists in a secondary public folder mailbox, but not in the primary. - You can't use this switch with the Identity parameter or the Recurse or LostAndFound switches. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - ResultSize - - The ResultSize parameter specifies the maximum number of results to return. The default maximum is 10,000. For no limit on the returned results, set this parameter to Unlimited. This parameter can only be passed in combination with the Recurse or GetChildren parameters. - - Unlimited - - Unlimited - - - None - - - - - - 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. - You can't use this switch with the Recurse or LostAndFound switches. - - SwitchParameter - - SwitchParameter - - - False - - - Recurse - - The Recurse switch specifies whether to return the specified public folder and all its children. You don't need to specify a value with this switch. - You can't use this switch with the GetChildren or LostAndFound switches. - - SwitchParameter - - SwitchParameter - - - False - - - Identity - - The Identity parameter specifies the name and path of the public folder you want to view. A valid value uses the syntax: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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. - The LOST_AND_FOUND folder holds missing folders that are recreated by the public folder hierarchy reconciliation process when the folder exists in a secondary public folder mailbox, but not in the primary. - You can't use this switch with the Identity parameter or the Recurse or LostAndFound switches. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ResultSize - - The ResultSize parameter specifies the maximum number of results to return. The default maximum is 10,000. For no limit on the returned results, set this parameter to Unlimited. This parameter can only be passed in combination with the Recurse or GetChildren parameters. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-PublicFolder - - This example uses the Get-PublicFolder command without parameters to return the root public folder object (IPM_SUBTREE). - - - - -------------------------- Example 2 -------------------------- - 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 -------------------------- - Get-PublicFolder -Identity "\Legal\Documents\Pending Litigation" - - This example returns the Pending Litigation public folder from \Legal\Documents\. - - - - -------------------------- Example 4 -------------------------- - 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 -------------------------- - 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 -------------------------- - Get-PublicFolder -Mailbox "Legal Department" -ResidentFolders - - This example returns the public folders that reside in the public folder content mailbox Legal Department. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-publicfolder - - - - - - Get-PublicFolderClientPermission - Get - PublicFolderClientPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - To view the permissions that are available on public folders, see Public folder permissions for Exchange Server (https://support.microsoft.com/help/2573274). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PublicFolderClientPermission - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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. - - PublicFolderUserIdParameter - - PublicFolderUserIdParameter - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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. - - PublicFolderUserIdParameter - - PublicFolderUserIdParameter - - - None - - - 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-publicfolderclientpermission - - - - - - Get-PublicFolderItemStatistics - Get - PublicFolderItemStatistics - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PublicFolderItemStatistics - - 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 - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - 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 - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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) - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-publicfolderitemstatistics - - - - - - Get-PublicFolderMailboxDiagnostics - Get - PublicFolderMailboxDiagnostics - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PublicFolderMailboxDiagnostics - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermailboxdiagnostics - - - - - - Get-PublicFolderStatistics - Get - PublicFolderStatistics - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-PublicFolderStatistics - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-publicfolderstatistics - - - - - - Get-SiteMailboxProvisioningPolicy - Get - SiteMailboxProvisioningPolicy - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes (https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). - Use the Get-SiteMailboxProvisioningPolicy cmdlet to view site mailbox provisioning policies. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Site mailboxes allow access to both Microsoft SharePoint documents and Exchange email using the same client interface. Site mailbox provisioning policies apply settings to new site mailboxes that you create. You can create multiple site mailbox provisioning policies, but only the default policy is followed when users create site mailboxes. The default site mailbox provisioning policy is named Default. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-SiteMailboxProvisioningPolicy - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-sitemailboxprovisioningpolicy - - - - - - Get-TextMessagingAccount - Get - TextMessagingAccount - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When text messaging notifications are enabled on a mailbox, you can configure calendar notifications, voice mail notifications, and email notifications using an inbox rule. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Get-TextMessagingAccount - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Credential - - The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. - A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see Get-Credential (https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). - - PSCredential - - PSCredential - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Unlimited - - Unlimited - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Get-TextMessagingAccount -Identity tony@contoso.com - - This example returns the text messaging settings for Tony's mailbox. - - - - -------------------------- Example 2 -------------------------- - $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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/get-textmessagingaccount - - - - - - New-App - New - App - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - If the app is enabled for the entire organization, users can activate the new app when viewing mail or calendar items within Microsoft Outlook or Outlook on the web. If an installed app isn't enabled, users can enable the app from Outlook on the web Options. Similarly, administrators can enable installed apps from the Exchange admin center or by using the Enable-App or Set-App cmdlet. - For more information, see Manage user access to add-ins for Outlook in Exchange Server (https://docs.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://docs.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-App - - AllowReadWriteMailbox - - The AllowReadWriteMailbox switch specifies whether the app allows read/write mailbox permission. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - DefaultStateForUser - - DefaultStateForUser - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - Etoken - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - MarketplaceAssetID - - The MarketplaceAssetID parameter specifies the Office Store identifier for the app. You need to use this parameter if you use theMarketplaceServicesUrl parameter. - - String - - String - - - None - - - MarketplaceCorrelationID - - The MarketplaceCorrelationID parameter specifies the Office Store correlation identifier for the app. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - MarketplaceUserProfileType - - The MarketplaceUserProfileType parameter specifies the user profile type for the Office Store. - - String - - String - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - ClientExtensionProvidedTo - - ClientExtensionProvidedTo - - - None - - - UserList - - The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to Centralized Deployment (https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-App - - AllowReadWriteMailbox - - The AllowReadWriteMailbox switch specifies whether the app allows read/write mailbox permission. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - DefaultStateForUser - - DefaultStateForUser - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - ClientExtensionProvidedTo - - ClientExtensionProvidedTo - - - None - - - UserList - - The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to Centralized Deployment (https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-App - - AllowReadWriteMailbox - - The AllowReadWriteMailbox switch specifies whether the app allows read/write mailbox permission. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - DefaultStateForUser - - DefaultStateForUser - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Stream - - Stream - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - ClientExtensionProvidedTo - - ClientExtensionProvidedTo - - - None - - - UserList - - The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to Centralized Deployment (https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - New-App - - AllowReadWriteMailbox - - The AllowReadWriteMailbox switch specifies whether the app allows read/write mailbox permission. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - DefaultStateForUser - - DefaultStateForUser - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - ClientExtensionProvidedTo - - ClientExtensionProvidedTo - - - None - - - 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. - - Uri - - Uri - - - None - - - UserList - - The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to Centralized Deployment (https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - DefaultStateForUser - - DefaultStateForUser - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - Etoken - - This parameter is reserved for internal Microsoft use. - - String - - String - - - None - - - 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))`. - - Byte[] - - Byte[] - - - None - - - 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. - - Stream - - Stream - - - None - - - 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 - - Alias - - Distinguished name (DN) - - Canonical DN - - Domain\Username - - Email address - - GUID - - LegacyExchangeDN - - SamAccountName - - User ID or user principal name (UPN) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - MarketplaceAssetID - - The MarketplaceAssetID parameter specifies the Office Store identifier for the app. You need to use this parameter if you use theMarketplaceServicesUrl parameter. - - String - - String - - - None - - - MarketplaceCorrelationID - - The MarketplaceCorrelationID parameter specifies the Office Store correlation identifier for the app. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - MarketplaceUserProfileType - - The MarketplaceUserProfileType parameter specifies the user profile type for the Office Store. - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - ClientExtensionProvidedTo - - ClientExtensionProvidedTo - - - None - - - 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. - - Uri - - Uri - - - None - - - UserList - - The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to Centralized Deployment (https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-app - - - - - - New-ClientAccessRule - New - ClientAccessRule - - This cmdlet is available or functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the New-ClientAccessRule cmdlet to create client access rules. Client access rules help you control access to your organization based on the properties of the connection. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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: - - 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. - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-ClientAccessRule - - Name - - The Name parameter specifies a unique name for the client access rule. - - String - - String - - - None - - - Action - - The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. - - ClientAccessRulesAction - - ClientAccessRulesAction - - - None - - - AnyOfAuthenticationTypes - - This parameter is available or 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - ExceptAnyOfAuthenticationTypes - - This parameter is available or 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptAnyOfProtocols - - This parameter is available or 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptUsernameMatchesAnyOfPatterns - - This parameter is available or 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 `<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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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). - - ClientAccessRulesScope - - ClientAccessRulesScope - - - None - - - UsernameMatchesAnyOfPatterns - - This parameter is available or 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 `<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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserRecipientFilter - - This parameter is available or 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. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"City -eq 'Redmond'"`). - - 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 on Exchange cmdlets (https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - The filterable properties that you can use with this parameter are: - - City - - Company - - CountryOrRegion - - CustomAttribute1 to CustomAttribute15 - - Department - - Office - - PostalCode - - StateOrProvince - - StreetAddress - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Action - - The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. - - ClientAccessRulesAction - - ClientAccessRulesAction - - - None - - - Name - - The Name parameter specifies a unique name for the client access rule. - - String - - String - - - None - - - AnyOfAuthenticationTypes - - This parameter is available or 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - ExceptAnyOfAuthenticationTypes - - This parameter is available or 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptAnyOfProtocols - - This parameter is available or 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptUsernameMatchesAnyOfPatterns - - This parameter is available or 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 `<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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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). - - ClientAccessRulesScope - - ClientAccessRulesScope - - - None - - - UsernameMatchesAnyOfPatterns - - This parameter is available or 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 `<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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserRecipientFilter - - This parameter is available or 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. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"City -eq 'Redmond'"`). - - 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 on Exchange cmdlets (https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - The filterable properties that you can use with this parameter are: - - City - - Company - - CountryOrRegion - - CustomAttribute1 to CustomAttribute15 - - Department - - Office - - PostalCode - - StateOrProvince - - StreetAddress - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-clientaccessrule - - - - - - New-DataEncryptionPolicy - New - DataEncryptionPolicy - - This cmdlet is available only in the cloud-based service. - Use the New-DataEncryptionPolicy cmdlet to create data encryption policies in Exchange Online. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Data encryption policy cmdlets are the Exchange Online part of service encryption with Customer Key in Microsoft 365. 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-DataEncryptionPolicy - - Name - - The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - 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 `<VaultName>` with the name of the vault, and run this command in Azure Rights Management PowerShell: `Get-AzureKeyVaultKey -VaultName <VaultName>).id`. For more information, see About Azure Key Vault (https://docs.microsoft.com/azure/key-vault/general/overview). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 `<VaultName>` with the name of the vault, and run this command in Azure Rights Management PowerShell: `Get-AzureKeyVaultKey -VaultName <VaultName>).id`. For more information, see About Azure Key Vault (https://docs.microsoft.com/azure/key-vault/general/overview). - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Name - - The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-dataencryptionpolicy - - - - - - New-M365DataAtRestEncryptionPolicy - New - M365DataAtRestEncryptionPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Use the New-M365DataAtRestEncryptionPolicy cmdlet to create a new Microsoft 365 data-at-rest encryption policy. For more information, see Overview of M365 Customer Key at the tenant level (https://docs.microsoft.com/microsoft-365/compliance/customer-key-tenant-level#get-policy-details). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-M365DataAtRestEncryptionPolicy - - 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 ("). - - String - - String - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the policy. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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"`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the policy. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 encryption policy named Default_Policy with the specified Azure Key Vault keys and description. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-m365dataatrestencryptionpolicy - - - - - - New-OMEConfiguration - New - OMEConfiguration - - This cmdlet is available only in the cloud-based service. - Use the New-OMEConfiguration cmdlet to create a Microsoft 365 Message Encryption (OME) configuration. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-OMEConfiguration - - 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 ("). - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/add-your-organization-brand-to-encrypted-messages). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - ExternalMailExpiryInDays - - This parameter is only available 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. - - String - - String - - - None - - - Image - - The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. - 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 - - Byte[] - - Byte[] - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - 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 ("). - - OrganizationIdParameter - - OrganizationIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/add-your-organization-brand-to-encrypted-messages). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - ExternalMailExpiryInDays - - This parameter is only available 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. - - String - - String - - - None - - - Image - - The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. - 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 - - Byte[] - - Byte[] - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-OMEConfiguration -Identity "Contoso Marketing" -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 creates a new OME configuration named "Contoso Marketing" with the specified values specified. Unused parameters get the default values. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/New-OMEConfiguration - - - - - - New-OwaMailboxPolicy - New - OwaMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-OwaMailboxPolicy - - Name - - The Name parameter specifies a name for the new policy. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies a name for the new policy. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - New-OwaMailboxPolicy -Name Corporate - - This example creates the Outlook on the web mailbox policy named Corporate. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-owamailboxpolicy - - - - - - New-PublicFolder - New - PublicFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - New-PublicFolder - - Name - - The Name parameter specifies the name for the public folder. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - EformsLocaleId - - The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Path - - The Path parameter specifies the location of the folder in the folder hierarchy, for example, \Legal\Cases. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Name - - The Name parameter specifies the name for the public folder. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - EformsLocaleId - - The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Path - - The Path parameter specifies the location of the folder in the folder hierarchy, for example, \Legal\Cases. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/new-publicfolder - - - - - - Remove-App - Remove - App - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Remove-App cmdlet requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet. Apps installed by default can't be uninstalled, but they can be disabled. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-App - - 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. - - AppIdParameter - - AppIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - AppIdParameter - - AppIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-App -Identity <GUID for FinanceTestApp> -Mailbox Tony - - This example removes the Finance Test app installed for user Tony. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-app - - - - - - Remove-ClientAccessRule - Remove - ClientAccessRule - - This cmdlet is available or functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Remove-ClientAccessRule cmdlet to remove client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-ClientAccessRule - - 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 - - ClientAccessRuleIdParameter - - ClientAccessRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - ClientAccessRuleIdParameter - - ClientAccessRuleIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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". - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-clientaccessrule - - - - - - Remove-OMEConfiguration - Remove - OMEConfiguration - - This cmdlet is available only in the cloud-based service. - Use the Remove-OMEConfiguration cmdlet to remove custom Microsoft 365 Message Encryption (OME) configurations. You can't use this cmdlet to remove the default OME configuration. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-OMEConfiguration - - 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 - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Remove-OMEConfiguration -Identity "Contoso Marketing" - - This example removes the custom OME configuration named Contoso Marketing. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/Remove-OMEConfiguration - - - - - - Remove-OwaMailboxPolicy - Remove - OwaMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-OwaMailboxPolicy - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-owamailboxpolicy - - - - - - Remove-PublicFolder - Remove - PublicFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-PublicFolder - - 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"`. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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"`. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-publicfolder - - - - - - Remove-PublicFolderClientPermission - Remove - PublicFolderClientPermission - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Remove-PublicFolderClientPermission - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - User - - The User parameter specifies the user principal name (UPN), domain\user, or alias of the user whose permissions are being removed. - - PublicFolderUserIdParameter - - PublicFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - User - - The User parameter specifies the user principal name (UPN), domain\user, or alias of the user whose permissions are being removed. - - PublicFolderUserIdParameter - - PublicFolderUserIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/remove-publicfolderclientpermission - - - - - - Send-TextMessagingVerificationCode - Send - TextMessagingVerificationCode - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Send-TextMessagingVerificationCode cmdlet generates a verification code and sends it to a user's mobile phone. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - This cmdlet returns an error if the user requests a verification code more than three times within a 24-hour period. - - - - Send-TextMessagingVerificationCode - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/send-textmessagingverificationcode - - - - - - Set-App - Set - App - - This cmdlet is available in 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-App cmdlet to modify the availability of organization apps. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - The Set-App cmdlet can only be used when configuring the availability of an organization app. This task requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet, or that it's a default app for Outlook). - Default apps in Outlook on the web and apps that you've installed for use by users in your organization are known as organization apps. Organization apps can't be removed by end users, but can be enabled or disabled. If an app is an organization app (scope default or organization), the delete control on the toolbar is disabled for end users. Administrators are able to remove organization apps. Administrators can't remove default apps, but they can disable them for the entire organization. - For more information, see Manage user access to add-ins for Outlook in Exchange Server (https://docs.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://docs.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-App - - Identity - - The Identity parameter specifies the AppID (GUID value) of the app that you want to modify. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. - - AppIdParameter - - AppIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DefaultStateForUser - - 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. - - DefaultStateForUser - - DefaultStateForUser - - - None - - - Enabled - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - ProvidedTo - - 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. - - ClientExtensionProvidedTo - - ClientExtensionProvidedTo - - - None - - - UserList - - The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to Centralized Deployment (https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). - 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"`. Maximum size of the list is 1000 recipients. - You use this parameter with the OrganizationApp switch. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the AppID (GUID value) of the app that you want to modify. To find the GUID value of an app, run the command Get-App | Format-Table -Auto DisplayName,AppId. - - AppIdParameter - - AppIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DefaultStateForUser - - 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. - - DefaultStateForUser - - DefaultStateForUser - - - None - - - Enabled - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - ProvidedTo - - 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. - - ClientExtensionProvidedTo - - ClientExtensionProvidedTo - - - None - - - UserList - - The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to Centralized Deployment (https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). - 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"`. Maximum size of the list is 1000 recipients. - You use this parameter with the OrganizationApp switch. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - $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. - - - - -------------------------- Example 2 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-app - - - - - - Set-CalendarNotification - Set - CalendarNotification - - This cmdlet is 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-CalendarNotification cmdlet allows users to set text message notification options for calendar events in their own calendar. By default, the MyTextMessaging end-user role gives access to this cmdlet, so admins can't configure text messaging notification for calendar events in user calendars. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Users can receive text message notifications of changes to calendar events and daily agendas. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-CalendarNotification - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - CalendarUpdateNotification - - The CalendarUpdateNotification parameter specifies whether calendar update notifications are sent to the user's mobile device. Valid values are: - - $true: Calendar update notifications are enabled. - - $false: Calendar update notifications aren't enabled. This is the default value. - - Boolean - - Boolean - - - None - - - CalendarUpdateSendDuringWorkHour - - The CalendarUpdateSendDuringWorkHour parameter specifies whether calendar update notifications are only sent to the user's mobile device during working hours. Valid values are: - - $true: Calendar update notifications are only sent during working hours. - - $false: Calendar update notifications are sent anytime. This is the default value. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DailyAgendaNotification - - The DailyAgendaNotification parameter specifies whether daily agenda notifications are sent to the user's mobile device. Valid values are: - - $true: Daily agenda notifications are sent. - - $false: Daily agenda notifications are not sent. This is the default value. - - Boolean - - Boolean - - - None - - - DailyAgendaNotificationSendTime - - The DailyAgendaNotificationSendTime parameter specifies the time to send daily agenda 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. - - TimeSpan - - TimeSpan - - - None - - - IgnoreDefaultScope - - This parameter is reserved for internal Microsoft use. - - - SwitchParameter - - - False - - - MeetingReminderNotification - - The MeetingReminderNotification parameter specifies whether meeting reminder notifications are sent to the user's mobile device. Valid values are: - - $true: Meeting reminder notifications are sent. - - $false: Meeting reminder notifications are not sent. This is the default value. - - Boolean - - Boolean - - - None - - - MeetingReminderSendDuringWorkHour - - The MeetingReminderSendDuringWorkHour parameter specifies whether meeting reminder notifications are only sent to the user's mobile device during working hours. Valid values are: - - $true: Meeting update notifications are only sent during working hours. - - $false: Meeting update notifications are sent anytime. This is the default value. - - Boolean - - Boolean - - - None - - - NextDays - - The NextDays parameter specifies how many days should be sent in the daily agenda notification to the user's mobile device. A valid value is an integer between 1 and 7. The default value is 1. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - CalendarUpdateNotification - - The CalendarUpdateNotification parameter specifies whether calendar update notifications are sent to the user's mobile device. Valid values are: - - $true: Calendar update notifications are enabled. - - $false: Calendar update notifications aren't enabled. This is the default value. - - Boolean - - Boolean - - - None - - - CalendarUpdateSendDuringWorkHour - - The CalendarUpdateSendDuringWorkHour parameter specifies whether calendar update notifications are only sent to the user's mobile device during working hours. Valid values are: - - $true: Calendar update notifications are only sent during working hours. - - $false: Calendar update notifications are sent anytime. This is the default value. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DailyAgendaNotification - - The DailyAgendaNotification parameter specifies whether daily agenda notifications are sent to the user's mobile device. Valid values are: - - $true: Daily agenda notifications are sent. - - $false: Daily agenda notifications are not sent. This is the default value. - - Boolean - - Boolean - - - None - - - DailyAgendaNotificationSendTime - - The DailyAgendaNotificationSendTime parameter specifies the time to send daily agenda 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. - - TimeSpan - - TimeSpan - - - None - - - IgnoreDefaultScope - - This parameter is reserved for internal Microsoft use. - - SwitchParameter - - SwitchParameter - - - False - - - MeetingReminderNotification - - The MeetingReminderNotification parameter specifies whether meeting reminder notifications are sent to the user's mobile device. Valid values are: - - $true: Meeting reminder notifications are sent. - - $false: Meeting reminder notifications are not sent. This is the default value. - - Boolean - - Boolean - - - None - - - MeetingReminderSendDuringWorkHour - - The MeetingReminderSendDuringWorkHour parameter specifies whether meeting reminder notifications are only sent to the user's mobile device during working hours. Valid values are: - - $true: Meeting update notifications are only sent during working hours. - - $false: Meeting update notifications are sent anytime. This is the default value. - - Boolean - - Boolean - - - None - - - NextDays - - The NextDays parameter specifies how many days should be sent in the daily agenda notification to the user's mobile device. A valid value is an integer between 1 and 7. The default value is 1. - - Int32 - - Int32 - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-calendarnotification - - - - - - Set-CASMailbox - Set - CASMailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-CASMailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-exchange-activesync), or [Enable or disable Exchange ActiveSync access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/exchange-activesync/activesync-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - EwsApplicationAccessPolicy - - EwsApplicationAccessPolicy - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. The other Exchange Web Services settings in this cmdlet are ignored. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MimeTextFormat - - MimeTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-mapi), or [Enable or disable MAPI access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/mapi-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - OWAEnabled - - The OWAEnabled parameter enables or disables access to the mailbox using Outlook on the web (formerly known as Outlook Web App or OWA). Valid values are: - - $true: Access to the mailbox using Outlook on the web is enabled. This is the default value. - - $false: Access to the mailbox using Outlook on the web is disabled. The other Outlook on the web settings in this cmdlet are ignored. - - For more information, see Enable or disable Outlook on the web for a mailbox in Exchange Online (https://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-outlook-web-app), or [Enable or disable Outlook on the web access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/outlook-on-the-web/mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MimeTextFormat - - MimeTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - PopUseProtocolDefaults - - The PopUseProtocolDefaults parameter specifies whether to use the POP3 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 following parameters: - - PopEnableExactRFC822Size - - PopForceICalForCalendarRetrievalOption - - PopMessagesRetrievalMimeFormat - - PopSuppressReadReceipt - - Boolean - - Boolean - - - None - - - PublicFolderClientAccess - - The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: - - $true: The user can access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true (the default value is $false). - - $false: The user can't access public folders in Outlook. This is the default value. - - Boolean - - Boolean - - - $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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - OneWinNativeOutlookEnabled - - This parameter is available only in the cloud-based service. - The OneWinNativeOutlookEnabled parameter enables or disables access to the new Outlook for Windows client. - Valid values for this parameter are: - - $true: Access to the new Outlook for Windows is enabled. - - $false: Access to the new Outlook for Windows is disabled. - - $null: Access to the new Outlook for Windows is determined by Microsoft. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-CASMailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-exchange-activesync), or [Enable or disable Exchange ActiveSync access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/exchange-activesync/activesync-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - EwsApplicationAccessPolicy - - EwsApplicationAccessPolicy - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. The other Exchange Web Services settings in this cmdlet are ignored. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MimeTextFormat - - MimeTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-mapi), or [Enable or disable MAPI access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/mapi-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - OWAEnabled - - The OWAEnabled parameter enables or disables access to the mailbox using Outlook on the web (formerly known as Outlook Web App or OWA). Valid values are: - - $true: Access to the mailbox using Outlook on the web is enabled. This is the default value. - - $false: Access to the mailbox using Outlook on the web is disabled. The other Outlook on the web settings in this cmdlet are ignored. - - For more information, see Enable or disable Outlook on the web for a mailbox in Exchange Online (https://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-outlook-web-app), or [Enable or disable Outlook on the web access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/outlook-on-the-web/mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MimeTextFormat - - MimeTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - PopUseProtocolDefaults - - The PopUseProtocolDefaults parameter specifies whether to use the POP3 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 following parameters: - - PopEnableExactRFC822Size - - PopForceICalForCalendarRetrievalOption - - PopMessagesRetrievalMimeFormat - - PopSuppressReadReceipt - - Boolean - - Boolean - - - None - - - PublicFolderClientAccess - - The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: - - $true: The user can access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true (the default value is $false). - - $false: The user can't access public folders in Outlook. This is the default value. - - Boolean - - Boolean - - - $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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - OneWinNativeOutlookEnabled - - This parameter is available only in the cloud-based service. - The OneWinNativeOutlookEnabled parameter enables or disables access to the new Outlook for Windows client. - Valid values for this parameter are: - - $true: Access to the new Outlook for Windows is enabled. - - $false: Access to the new Outlook for Windows is disabled. - - $null: Access to the new Outlook for Windows is determined by Microsoft. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-exchange-activesync), or [Enable or disable Exchange ActiveSync access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/exchange-activesync/activesync-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - EwsApplicationAccessPolicy - - EwsApplicationAccessPolicy - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. The other Exchange Web Services settings in this cmdlet are ignored. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MimeTextFormat - - MimeTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-mapi), or [Enable or disable MAPI access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/mapi-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - OWAEnabled - - The OWAEnabled parameter enables or disables access to the mailbox using Outlook on the web (formerly known as Outlook Web App or OWA). Valid values are: - - $true: Access to the mailbox using Outlook on the web is enabled. This is the default value. - - $false: Access to the mailbox using Outlook on the web is disabled. The other Outlook on the web settings in this cmdlet are ignored. - - For more information, see Enable or disable Outlook on the web for a mailbox in Exchange Online (https://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-outlook-web-app), or [Enable or disable Outlook on the web access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/outlook-on-the-web/mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MimeTextFormat - - MimeTextFormat - - - None - - - 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. - - Boolean - - Boolean - - - None - - - PopUseProtocolDefaults - - The PopUseProtocolDefaults parameter specifies whether to use the POP3 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 following parameters: - - PopEnableExactRFC822Size - - PopForceICalForCalendarRetrievalOption - - PopMessagesRetrievalMimeFormat - - PopSuppressReadReceipt - - Boolean - - Boolean - - - None - - - PublicFolderClientAccess - - The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: - - $true: The user can access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true (the default value is $false). - - $false: The user can't access public folders in Outlook. This is the default value. - - Boolean - - Boolean - - - $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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - OneWinNativeOutlookEnabled - - This parameter is available only in the cloud-based service. - The OneWinNativeOutlookEnabled parameter enables or disables access to the new Outlook for Windows client. - Valid values for this parameter are: - - $true: Access to the new Outlook for Windows is enabled. - - $false: Access to the new Outlook for Windows is disabled. - - $null: Access to the new Outlook for Windows is determined by Microsoft. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-casmailbox - - - - - - Set-ClientAccessRule - Set - ClientAccessRule - - This cmdlet is available or functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Set-ClientAccessRule cmdlet to modify existing client access rules. Client access rules help you control access to your organization based on the properties of the connection. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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: - - 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. - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-ClientAccessRule - - 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 - - ClientAccessRuleIdParameter - - ClientAccessRuleIdParameter - - - None - - - Action - - The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. - - ClientAccessRulesAction - - ClientAccessRulesAction - - - None - - - AnyOfAuthenticationTypes - - This parameter is available or 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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, 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the client access rule is enabled or disabled. Valid values for this parameter are $true or $false. - - Boolean - - Boolean - - - None - - - ExceptAnyOfAuthenticationTypes - - This parameter is available or 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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, 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptAnyOfProtocols - - This parameter is available or 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptUsernameMatchesAnyOfPatterns - - This parameter is available or 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 `<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, 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Name - - The Name parameter specifies a unique name for the client access rule. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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). - - ClientAccessRulesScope - - ClientAccessRulesScope - - - None - - - UsernameMatchesAnyOfPatterns - - This parameter is available or 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 `<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, 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserRecipientFilter - - This parameter is available or 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. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"City -eq 'Redmond'"`). - - Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - - Property is a filterable property. - - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - The filterable properties that you can use with this parameter are: - - City - - Company - - CountryOrRegion - - CustomAttribute1 to CustomAttribute15 - - Department - - Office - - PostalCode - - StateOrProvince - - StreetAddress - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - ClientAccessRuleIdParameter - - ClientAccessRuleIdParameter - - - None - - - Action - - The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. - - ClientAccessRulesAction - - ClientAccessRulesAction - - - None - - - AnyOfAuthenticationTypes - - This parameter is available or 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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, 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Enabled - - The Enabled parameter specifies whether the client access rule is enabled or disabled. Valid values for this parameter are $true or $false. - - Boolean - - Boolean - - - None - - - ExceptAnyOfAuthenticationTypes - - This parameter is available or 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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, 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptAnyOfProtocols - - This parameter is available or 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExceptUsernameMatchesAnyOfPatterns - - This parameter is available or 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 `<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, 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Name - - The Name parameter specifies a unique name for the client access rule. - - String - - String - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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). - - ClientAccessRulesScope - - ClientAccessRulesScope - - - None - - - UsernameMatchesAnyOfPatterns - - This parameter is available or 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 `<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, 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"...}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - UserRecipientFilter - - This parameter is available or 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. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"City -eq 'Redmond'"`). - - Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - - Property is a filterable property. - - ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - 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 (for example, `500`, `$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"`. - For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - The filterable properties that you can use with this parameter are: - - City - - Company - - CountryOrRegion - - CustomAttribute1 to CustomAttribute15 - - Department - - Office - - PostalCode - - StateOrProvince - - StreetAddress - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-clientaccessrule - - - - - - Set-DataEncryptionPolicy - Set - DataEncryptionPolicy - - This cmdlet is available only in the cloud-based service. - Use the Set-DataEncryptionPolicy cmdlet to modify data encryption policies in Exchange Online. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-DataEncryptionPolicy - - Identity - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - PermanentDataPurgeContact - - The PermanentDataPurgeContact parameter specifies a contact for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. - You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeReason parameters. - - String - - String - - - None - - - PermanentDataPurgeReason - - The PermanentDataPurgeReason parameter specifies a descriptive reason for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. - You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeContact parameters. - - String - - String - - - None - - - PermanentDataPurgeRequested - - The PermanentDataPurgeRequested switch specifies whether to initiate the deletion of all data that's encrypted by the data encryption policy. You don't need to specify a value with this switch. - You need to use this switch with the PermanentDataPurgeReason and PermanentDataPurgeContact parameters. - After you use this switch, you can't assign the data encryption policy to other mailboxes. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - Enabled - - The Enabled parameter enables or disable the data encryption policy. Valid values are: - - $true: The policy is enabled. - - $false: The policy is disabled. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-DataEncryptionPolicy - - Identity - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - PermanentDataPurgeContact - - The PermanentDataPurgeContact parameter specifies a contact for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. - You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeReason parameters. - - String - - String - - - None - - - PermanentDataPurgeReason - - The PermanentDataPurgeReason parameter specifies a descriptive reason for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. - You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeContact parameters. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - Enabled - - The Enabled parameter enables or disable the data encryption policy. Valid values are: - - $true: The policy is enabled. - - $false: The policy is disabled. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-DataEncryptionPolicy - - Identity - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Refresh - - Use the Refresh switch to update the data encryption policy in Exchange Online after you rotate any of the associated keys in the Azure Key Vault. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - Enabled - - The Enabled parameter enables or disable the data encryption policy. Valid values are: - - $true: The policy is enabled. - - $false: The policy is disabled. - - Boolean - - Boolean - - - None - - - Name - - The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - Identity - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - PermanentDataPurgeContact - - The PermanentDataPurgeContact parameter specifies a contact for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. - You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeReason parameters. - - String - - String - - - None - - - PermanentDataPurgeReason - - The PermanentDataPurgeReason parameter specifies a descriptive reason for the purge of all data that's encrypted by the data encryption policy. If the value contains spaces, enclose the value in quotation marks. - You need to use this parameter with the PermanentDataPurgeRequested and PermanentDataPurgeContact parameters. - - String - - String - - - None - - - PermanentDataPurgeRequested - - The PermanentDataPurgeRequested switch specifies whether to initiate the deletion of all data that's encrypted by the data encryption policy. You don't need to specify a value with this switch. - You need to use this switch with the PermanentDataPurgeReason and PermanentDataPurgeContact parameters. - After you use this switch, you can't assign the data encryption policy to other mailboxes. - - SwitchParameter - - SwitchParameter - - - False - - - Refresh - - Use the Refresh switch to update the data encryption policy in Exchange Online after you rotate any of the associated keys in the Azure Key Vault. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - Enabled - - The Enabled parameter enables or disable the data encryption policy. Valid values are: - - $true: The policy is enabled. - - $false: The policy is disabled. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-DataEncryptionPolicy -Identity "US Mailboxes" -Enabled $false - - This example disabled the data encryption policy named US Mailboxes. - - - - -------------------------- Example 2 -------------------------- - Set-DataEncryptionPolicy -Identity "Europe Mailboxes" -Refresh - - This example updates the data encryption policy named Europe Mailboxes after one of the associated keys has been rotated in the Azure Key Vault. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-dataencryptionpolicy - - - - - - Set-M365DataAtRestEncryptionPolicy - Set - M365DataAtRestEncryptionPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-M365DataAtRestEncryptionPolicy - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the policy. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-M365DataAtRestEncryptionPolicy - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the policy. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Set-M365DataAtRestEncryptionPolicy - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the policy. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - Description - - The Description parameter specifies an optional description for the policy. - - String - - String - - - None - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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 ("). - - String - - String - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicy - - - - - - Set-M365DataAtRestEncryptionPolicyAssignment - Set - M365DataAtRestEncryptionPolicyAssignment - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-M365DataAtRestEncryptionPolicyAssignment - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - - - - 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 - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-M365DataAtRestEncryptionPolicyAssignment -DataEncryptionPolicy "Contoso Corporate" - - This example assigns the Microsoft 365 data-at-rest encryption policy named Contoso Corporate. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicyassignment - - - - - - Set-MailPublicFolder - Set - MailPublicFolder - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-MailPublicFolder - - 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. - - MailPublicFolderIdParameter - - MailPublicFolderIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExternalEmailAddress - - The ExternalEmailAddress parameter specifies an email address outside the organization. - - ProxyAddress - - ProxyAddress - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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 <PublicFolder>`), 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - OnPremisesObjectId - - The OnPremisesObjectId parameter specifies the ObjectID (GUID) value of the mail-enabled public folder from the on-premises environment. - - Guid - - Guid - - - None - - - 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 ("). - - String - - String - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. - The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - 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. - - MailPublicFolderIdParameter - - MailPublicFolderIdParameter - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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 following 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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"`. - - RecipientIdParameter[] - - RecipientIdParameter[] - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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 ("). - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - EmailAddresses - - The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange Server (https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). - Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - - SMTP: The primary SMTP address. You can use this value only once in a command. - - smtp: Other SMTP email addresses. - - X400: X.400 addresses in on-premises Exchange. - - X500: X.500 addresses in on-premises Exchange. - - If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. - 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",...}`. - - ProxyAddressCollection - - ProxyAddressCollection - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - ExternalEmailAddress - - The ExternalEmailAddress parameter specifies an email address outside the organization. - - ProxyAddress - - ProxyAddress - - - None - - - 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. - - RecipientIdParameter - - RecipientIdParameter - - - None - - - 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 <PublicFolder>`), 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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."}`. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - Unlimited - - Unlimited - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 ("). - - String - - String - - - None - - - OnPremisesObjectId - - The OnPremisesObjectId parameter specifies the ObjectID (GUID) value of the mail-enabled public folder from the on-premises environment. - - Guid - - Guid - - - None - - - 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 ("). - - String - - String - - - None - - - PrimarySmtpAddress - - The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. - If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. - The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. - - SmtpAddress - - SmtpAddress - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - TransportModerationNotificationFlags - - TransportModerationNotificationFlags - - - None - - - 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 - - `" ' ( ) + , - . / : ?` - - String - - String - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - 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. - - SmtpAddress - - SmtpAddress - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-mailpublicfolder - - - - - - Set-Notification - Set - Notification - - This cmdlet is available in 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: - - 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-Notification - - 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. - 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). - You can't use this parameter with the ProcessType parameter. - - EwsStoreObjectIdParameter - - EwsStoreObjectIdParameter - - - None - - - NotificationEmails - - The NotificationEmails parameter specifies the recipients for notification emails related to notification events. You can specify multiple recipients separated by commas. - You need to use this parameter with either the ProcessType or Identity parameters: - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - 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). - You can't use this parameter with the ProcessType parameter. - - EwsStoreObjectIdParameter - - EwsStoreObjectIdParameter - - - None - - - NotificationEmails - - The NotificationEmails parameter specifies the recipients for notification emails related to notification events. You can specify multiple recipients separated by commas. - You need to use this parameter with either the ProcessType or Identity parameters: - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - Set-Notification -Identity 0259ec74-3539-4195-ab4f-de93e654ceaf -NotificationEmails laura@contoso.com,julia@contoso.com - - This example configures the specified notification event to send notification email messages to laura@contoso.com and julia@contoso.com. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-notification - - - - - - Set-OMEConfiguration - Set - OMEConfiguration - - This cmdlet is available only in the cloud-based service. - Use the Set-OMEConfiguration cmdlet to configure Microsoft 365 Message Encryption (OME). Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-OMEConfiguration - - Identity - - The Identity parameter specifies the OME configuration that you want to modify. The default OME configuration has the Identity value "OME Configuration". - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/add-your-organization-brand-to-encrypted-messages#background-color-reference). - $null (blank). This is the default value. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - ExternalMailExpiryInDays - - This parameter is only available 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. - - String - - String - - - None - - - Image - - The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. - 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. - - Byte[] - - Byte[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - - - - Identity - - The Identity parameter specifies the OME configuration that you want to modify. The default OME configuration has the Identity value "OME Configuration". - - OMEConfigurationIdParameter - - OMEConfigurationIdParameter - - - None - - - 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://docs.microsoft.com/microsoft-365/compliance/add-your-organization-brand-to-encrypted-messages#background-color-reference). - $null (blank). This is the default value. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - ExternalMailExpiryInDays - - This parameter is only available 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. - - String - - String - - - None - - - Image - - The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. - 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. - - Byte[] - - Byte[] - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 configures the specified values for the default OME configuration named "OME Configuration". Note the use of the Get-Content command to provide the input for the Image parameter. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-omeconfiguration - - - - - - Set-OMEMessageRevocation - Set - OMEMessageRevocation - - This cmdlet is available only in the cloud-based service. - Use the Set-OMEMessageRevocation cmdlet to revoke Microsoft 365 Message Encryption (OME) for a message. Revoking encryption prevents the recipient from viewing the message in the Office 365 Message Encryption portal. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - When an email has been revoked, the recipient will get the following error when they try to view the encrypted message in the Office 365 Message Encryption 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-OMEMessageRevocation - - 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, "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>"). - You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Security & Compliance Center. - - String - - String - - - None - - - 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 Office 365 Message Encryption portal - - $false: Encryption for the specified message isn't revoked. This is the default value. - - Boolean - - Boolean - - - None - - - - - - 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, "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>"). - You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Security & Compliance Center. - - String - - String - - - None - - - 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 Office 365 Message Encryption portal - - $false: Encryption for the specified message isn't revoked. This is the default value. - - Boolean - - Boolean - - - None - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Set-OMEMessageRevocation -MessageId "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>" -Revoke $true - - This example revokes encryption for the specified message. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-omemessagerevocation - - - - - - Set-OwaMailboxPolicy - Set - OwaMailboxPolicy - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - In on-premises Exchange, the default Outlook on the web mailbox policy is named Default. In Exchange Online, the default Outlook on the web mailbox policy is named OwaMailboxPolicy-Default. - Changes to Outlook on the web mailbox polices may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-OwaMailboxPolicy - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 - - AttachmentBlockingActions - - AttachmentBlockingActions - - - None - - - 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. - - Boolean - - Boolean - - - True - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - AllowOfflineOnEnum - - AllowOfflineOnEnum - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - BookingsMailboxCreationEnabled - - This parameter is available only in the cloud-based service. - The BookingsMailboxCreationEnabled parameter allows you disable Microsoft Bookings. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ConditionalAccessPolicy - - This parameter is available only in the cloud-based service. - The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy for limited access. For this feature to work properly, you also need to configure a Conditional Access policy in the Azure Active Directory Portal. Note : When you enable a Conditional Access policy, users will no longer be able to access the light version of Outlook on the web. An error message will direct them to use the default premium experience. - Valid values are: - - Off: No conditional access policy is applied to Outlook on the web. This is the default value. - - ReadOnly: Users can't download attachments to their local computer, and can't enable Offline Mode on non-compliant computers. They can still view attachments in the browser. - - ReadOnlyPlusAttachmentsBlocked: All restrictions from ReadOnly apply, but users can't view attachments in the browser. - - PolicyEnum - - PolicyEnum - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DefaultClientLanguage - - This parameter has been deprecated and is no longer used. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - DelegateAccessEnabled - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - DisableFacebook - - This parameter is available only in the cloud-based service. - 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. - - Note that the value of this parameter is stored in the FacebookEnabled property in the output of the Get-OwaMailboxPolicy cmdlet. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - GroupCreationEnabled - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - 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: Instant messaging isn't available in Outlook on the web. - - Boolean - - Boolean - - - None - - - 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. - - InstantMessagingTypeOptions - - InstantMessagingTypeOptions - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/powershell/module/exchange/set-casmailboxplan). That value will instead be applied per each mailbox's SKU. - - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - LinkedInEnabled - - This parameter is available only in the cloud-based service. - LinkedIn integration is no longer supported. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 uses 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. - - Boolean - - Boolean - - - None - - - BizBarEnabled - - This parameter is available only in the cloud-based service. - The BizBarEnabled parameter specifies whether Bizbar banner is available in Outlook on the web, this banner is shown on top of user mailbox. Valid values are: - - $true: The Bizbar is available in Outlook on the web. This is the default value. - - $false: The Bizbar isn't available in Outlook on the web. - - Boolean - - Boolean - - - None - - - EmptyStateEnabled - - This parameter is available only in the cloud-based service. - The EmptyStateEnabled parameter specifies whether empty state experience is available in Outlook on the web, this is the space that is shown in reading pane area when no email is selected. Valid values are: - - $true: The EmptyState is available in Outlook on the web. This is the default value. - - $false: The EmptyState isn't available in Outlook on the web. - - Boolean - - Boolean - - - None - - - AccountTransferEnabled - - This parameter is available only in the cloud-based service. - The AccountTransferEnabled parameter specifies when the Account Transfer feature is enable in the Outlook interface. Valid values are: - - $true: Enables the Account Transfer functionality for the user, by displaying the "Outlook mobile" button on the help ribbon tab. This is the default value. - - $false: The "Outlook mobile" button on the help ribbon tab in Outlook on the web. - - Boolean - - Boolean - - - None - - - OfflineEnabledWeb - - This parameter is available only in the cloud-based service. - The OfflineEnabledWeb parameter specifies whether offline support is available in Outlook on the web. Valid values are: - - $true: Offline support is available in Outlook on the web. This is the default value. - - $false: Offline support isn't available in Outlook on the web. - - Boolean - - Boolean - - - True - - - OfflineEnabledWin - - This parameter is available only in the cloud-based service. - The OfflineEnabledWin parameter specifies whether offline support is available in the new Outlook for Windows. Valid values are: - - $true: Offline support is available in the new Outlook for Windows. This is the default value. - - $false: Offline support isn't available in the new Outlook for Windows. - - Boolean - - Boolean - - - True - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - OutboundCharsetOptions - - OutboundCharsetOptions - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - PhoneticSupportEnabled - - The PhoneticSupportEnabled parameter specifies phonetically spelled entries in the address book. This parameter is available for use in Japan. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ProjectMocaEnabled - - Note: The feature associated with this parameter was a Preview feature that has been deprecated and is no longer available. - This parameter was available only in the cloud-based service. - The ProjectMocaEnabled parameter enabled or disabled 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ReportJunkEmailEnabled - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SkipCreateUnifiedGroupCustomSharepointClassification - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ThirdPartyAttachmentsEnabled - - This parameter is available or functional 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 AdditionalStorageProvidersAvailable parameter. - - Boolean - - Boolean - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - UserVoiceEnabled - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - WebPartsFrameOptions - - WebPartsFrameOptions - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - WSSAccessOnPrivateComputersEnabled - - This parameter has been deprecated and is no longer used. - - Boolean - - Boolean - - - None - - - WSSAccessOnPublicComputersEnabled - - This parameter has been deprecated and is no longer used. - - Boolean - - Boolean - - - None - - - - - - 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 - - MailboxPolicyIdParameter - - MailboxPolicyIdParameter - - - None - - - 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 - - AttachmentBlockingActions - - AttachmentBlockingActions - - - None - - - 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. - - Boolean - - Boolean - - - True - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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). - - AllowOfflineOnEnum - - AllowOfflineOnEnum - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - BookingsMailboxCreationEnabled - - This parameter is available only in the cloud-based service. - The BookingsMailboxCreationEnabled parameter allows you disable Microsoft Bookings. - - Boolean - - Boolean - - - None - - - SMimeSuppressNameChecksEnabled - - This parameter is available only in the cloud-based service. - The SMimeSuppressNameChecksEnabled parameter allows you suppress name checks in S/MIME certificates. If enabled, certificates with Subject and/or Subject Alternate Name (SAN) not matching the mailbox are allowed. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ConditionalAccessPolicy - - This parameter is available only in the cloud-based service. - The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy for limited access. For this feature to work properly, you also need to configure a Conditional Access policy in the Azure Active Directory Portal. Note : When you enable a Conditional Access policy, users will no longer be able to access the light version of Outlook on the web. An error message will direct them to use the default premium experience. - Valid values are: - - Off: No conditional access policy is applied to Outlook on the web. This is the default value. - - ReadOnly: Users can't download attachments to their local computer, and can't enable Offline Mode on non-compliant computers. They can still view attachments in the browser. - - ReadOnlyPlusAttachmentsBlocked: All restrictions from ReadOnly apply, but users can't view attachments in the browser. - - PolicyEnum - - PolicyEnum - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DefaultClientLanguage - - This parameter has been deprecated and is no longer used. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - DelegateAccessEnabled - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - DisableFacebook - - This parameter is available only in the cloud-based service. - 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. - - Note that the value of this parameter is stored in the FacebookEnabled property in the output of the Get-OwaMailboxPolicy cmdlet. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - MultiValuedProperty - - MultiValuedProperty - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - GroupCreationEnabled - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - 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: Instant messaging isn't available in Outlook on the web. - - Boolean - - Boolean - - - None - - - 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. - - InstantMessagingTypeOptions - - InstantMessagingTypeOptions - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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://docs.microsoft.com/powershell/module/exchange/set-casmailboxplan). That value will instead be applied per each mailbox's SKU. - - SwitchParameter - - SwitchParameter - - - 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. - - Boolean - - Boolean - - - None - - - LinkedInEnabled - - This parameter is available only in the cloud-based service. - LinkedIn integration is no longer supported. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Int32 - - Int32 - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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 uses 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. - - Boolean - - Boolean - - - None - - - BizBarEnabled - - This parameter is available only in the cloud-based service. - The BizBarEnabled parameter specifies whether Bizbar banner is available in Outlook on the web, this banner is shown on top of user mailbox. Valid values are: - - $true: The Bizbar is available in Outlook on the web. - - $false: The Bizbar isn't available in Outlook on the web. This is the default value. - - Boolean - - Boolean - - - None - - - EmptyStateEnabled - - This parameter is available only in the cloud-based service. - The EmptyStateEnabled parameter specifies whether empty state experience is available in Outlook on the web, this is the space that is shown in reading pane area when no email is selected. Valid values are: - - $true: The EmptyState is available in Outlook on the web. - - $false: The EmptyState isn't available in Outlook on the web. This is the default value. - - Boolean - - Boolean - - - None - - - AccountTransferEnabled - - This parameter is available only in the cloud-based service. - The AccountTransferEnabled parameter specifies when the Account Transfer feature is enabled or disabled in the Outlook interface. Valid values are: - - $true: Enables the Account Transfer functionality for the user, by displaying the "Outlook mobile" button on the help ribbon tab. This is the default value. - - $false: This will hide the "Outlook mobile" button on the help ribbon tab in Outlook on the web. - - Boolean - - Boolean - - - None - - - OfflineEnabledWeb - - This parameter is available only in the cloud-based service. - The OfflineEnabledWeb parameter specifies whether offline support is available in Outlook on the web. Valid values are: - - $true: Offline support is available in Outlook on the web. This is the default value. - - $false: Offline support isn't available in Outlook on the web. - - Boolean - - Boolean - - - True - - - OfflineEnabledWin - - This parameter is available only in the cloud-based service. - The OfflineEnabledWin parameter specifies whether offline support is available in the new Outlook for Windows. Valid values are: - - $true: Offline support is available in the new Outlook for Windows. This is the default value. - - $false: Offline support isn't available in the new Outlook for Windows. - - Boolean - - Boolean - - - True - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - OutboundCharsetOptions - - OutboundCharsetOptions - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - PhoneticSupportEnabled - - The PhoneticSupportEnabled parameter specifies phonetically spelled entries in the address book. This parameter is available for use in Japan. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ReportJunkEmailEnabled - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - String - - String - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - SkipCreateUnifiedGroupCustomSharepointClassification - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - ThirdPartyAttachmentsEnabled - - This parameter is available or functional 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 AdditionalStorageProvidersAvailable parameter. - - Boolean - - Boolean - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - UserVoiceEnabled - - This parameter is available or 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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). - - Boolean - - Boolean - - - None - - - 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. - - Boolean - - Boolean - - - None - - - 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. - - WebPartsFrameOptions - - WebPartsFrameOptions - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - WSSAccessOnPrivateComputersEnabled - - This parameter has been deprecated and is no longer used. - - Boolean - - Boolean - - - None - - - WSSAccessOnPublicComputersEnabled - - This parameter has been deprecated and is no longer used. - - Boolean - - Boolean - - - None - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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 Exchange Online 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 Microsoft 365. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-owamailboxpolicy - - - New-OwaMailboxPolicy - https://docs.microsoft.com/powershell/module/exchange/new-owamailboxpolicy - - - Get-OwaMailboxPolicy - https://docs.microsoft.com/powershell/module/exchange/get-owamailboxpolicy - - - Set-CASMailbox - https://docs.microsoft.com/powershell/module/exchange/set-casmailbox - - - Outlook on the web mailbox policy procedures in Exchange Online - https://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-on-the-web/outlook-web-app-mailbox-policy-procedures - - - - - - Set-PublicFolder - Set - PublicFolder - - This cmdlet is available in 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-PublicFolder cmdlet to set the attributes of public folders. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-PublicFolder - - 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\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - AgeLimit - - The AgeLimit parameter specifies the overall age limit on the folder. Replicas of this public folder are automatically deleted when the age limit is exceeded. - To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - EformsLocaleId - - The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - - SwitchParameter - - - False - - - IssueWarningQuota - - The IssueWarningQuota parameter specifies the public folder size that triggers a warning to public folder owners stating that the folder is almost full. - The default value is unlimited, which is 2 terabytes. - 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 2TB. - - Unlimited - - Unlimited - - - None - - - MailEnabled - - The MailEnabled parameter specifies that the public folder is mail-enabled. To do this, you use the value $true. - You use this parameter to correct a mail-enabled public folder that lost its mail-enabled status. If you attempt to use this parameter to mail-enable a public folder that was never mail-enabled, the command will fail. - - Boolean - - Boolean - - - None - - - MailRecipientGuid - - The MailRecipientGuid parameter specifies the MailRecipientGuid value of the public folder. You use this parameter to correct a mail-enabled public folder that lost its MailRecipientGuid value. - The value that you specify for this parameter must match the MailRecipientGuid value of an existing mail-enabled public folder. Otherwise, the command will fail. - - Guid - - Guid - - - None - - - MaxItemSize - - The MaxItemSize parameter specifies the maximum size for posted items. Items larger than the value of the MaxItemSize parameter are rejected. The default value is unlimited, which is 2 gigabytes. When you enter a value, qualify the value with one of the following units: - When you enter a value, qualify the value with one of the following units: - - 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 2GB. - - Unlimited - - Unlimited - - - None - - - Name - - The Name parameter specifies the name for the public folder. - - String - - String - - - None - - - Path - - The Path parameter specifies the path of the public folder, for example, \TopLevelPublicFolder\PublicFolder. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - PerUserReadStateEnabled - - The PerUserReadStateEnabled parameter specifies whether to maintain read and unread data on a per-user basis. - - Boolean - - Boolean - - - None - - - 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 whose size is larger than the ProhibitPostQuota parameter value. The default value is unlimited, which is 2 terabytes. - When you enter a value, qualify the value with one of the following units: - - 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 2TB. - - Unlimited - - Unlimited - - - None - - - RetainDeletedItemsFor - - The RetainDeletedItemsFor parameter specifies the retention time for deleted items. - To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - AgeLimit - - The AgeLimit parameter specifies the overall age limit on the folder. Replicas of this public folder are automatically deleted when the age limit is exceeded. - To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - EformsLocaleId - - The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at CultureInfo Class (https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - - CultureInfo - - CultureInfo - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - IssueWarningQuota - - The IssueWarningQuota parameter specifies the public folder size that triggers a warning to public folder owners stating that the folder is almost full. - The default value is unlimited, which is 2 terabytes. - 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 2TB. - - Unlimited - - Unlimited - - - None - - - MailEnabled - - The MailEnabled parameter specifies that the public folder is mail-enabled. To do this, you use the value $true. - You use this parameter to correct a mail-enabled public folder that lost its mail-enabled status. If you attempt to use this parameter to mail-enable a public folder that was never mail-enabled, the command will fail. - - Boolean - - Boolean - - - None - - - MailRecipientGuid - - The MailRecipientGuid parameter specifies the MailRecipientGuid value of the public folder. You use this parameter to correct a mail-enabled public folder that lost its MailRecipientGuid value. - The value that you specify for this parameter must match the MailRecipientGuid value of an existing mail-enabled public folder. Otherwise, the command will fail. - - Guid - - Guid - - - None - - - MaxItemSize - - The MaxItemSize parameter specifies the maximum size for posted items. Items larger than the value of the MaxItemSize parameter are rejected. The default value is unlimited, which is 2 gigabytes. When you enter a value, qualify the value with one of the following units: - When you enter a value, qualify the value with one of the following units: - - 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 2GB. - - Unlimited - - Unlimited - - - None - - - Name - - The Name parameter specifies the name for the public folder. - - String - - String - - - None - - - Path - - The Path parameter specifies the path of the public folder, for example, \TopLevelPublicFolder\PublicFolder. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - PerUserReadStateEnabled - - The PerUserReadStateEnabled parameter specifies whether to maintain read and unread data on a per-user basis. - - Boolean - - Boolean - - - None - - - 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 whose size is larger than the ProhibitPostQuota parameter value. The default value is unlimited, which is 2 terabytes. - When you enter a value, qualify the value with one of the following units: - - 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 2TB. - - Unlimited - - Unlimited - - - None - - - RetainDeletedItemsFor - - The RetainDeletedItemsFor parameter specifies the retention time for deleted items. - To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. - - EnhancedTimeSpan - - EnhancedTimeSpan - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - Set-PublicFolder \MyPublicFolder -ReplicationSchedule "Saturday.12:00 AM-Monday.12:00 AM" - - In Exchange 2010, this example sets the folder to replicate only on weekends. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-publicfolder - - - - - - Set-SiteMailboxProvisioningPolicy - Set - SiteMailboxProvisioningPolicy - - This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes (https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). - Use the Set-SiteMailboxProvisioningPolicy cmdlet to modify an existing site mailbox provisioning policy. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - Site mailbox provisioning policies apply settings to new site mailboxes that you create. You can create multiple site mailbox provisioning policies, but only the default policy is followed when users create site mailboxes. The default site mailbox provisioning policy is named Default. - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-SiteMailboxProvisioningPolicy - - AliasPrefix - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - AliasPrefix - - 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. - - String - - String - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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 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. - - Boolean - - Boolean - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - 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 -------------------------- - 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 -------------------------- - 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-sitemailboxprovisioningpolicy - - - - - - Set-TextMessagingAccount - Set - TextMessagingAccount - - This cmdlet is 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Set-TextMessagingAccount - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - CountryRegionId - - The CountryRegionId parameter specifies the country that your mobile phone is registered in. Although this parameter accepts any valid ISO 3166-1 two-letter country code value (for example, AU for Australia), the following values correspond to the country selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): - - 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). - - RegionInfo - - RegionInfo - - - None - - - 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. - - - SwitchParameter - - - False - - - MobileOperatorId - - The MobileOperatorId parameter specifies the mobile operator (carrier) for your phone. Although this parameter accepts any random number, the following values correspond to the country and mobile operator selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): - United States: - - AT&T: 15001 - - Sprint PCS: 15004 - - T-Mobile: 15005 - - Verizon Wireless: 15006 - - Canada: - - Bell: 17001 - - Telus Mobility: 17002 - - Romania: - - Orange Romania: 18001 - - Int32 - - Int32 - - - None - - - 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`). - - E164Number - - E164Number - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - CountryRegionId - - The CountryRegionId parameter specifies the country that your mobile phone is registered in. Although this parameter accepts any valid ISO 3166-1 two-letter country code value (for example, AU for Australia), the following values correspond to the country selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): - - 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). - - RegionInfo - - RegionInfo - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - MobileOperatorId - - The MobileOperatorId parameter specifies the mobile operator (carrier) for your phone. Although this parameter accepts any random number, the following values correspond to the country and mobile operator selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): - United States: - - AT&T: 15001 - - Sprint PCS: 15004 - - T-Mobile: 15005 - - Verizon Wireless: 15006 - - Canada: - - Bell: 17001 - - Telus Mobility: 17002 - - Romania: - - Orange Romania: 18001 - - Int32 - - Int32 - - - None - - - 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`). - - E164Number - - E164Number - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- 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. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/set-textmessagingaccount - - - - - - Test-ClientAccessRule - Test - ClientAccessRule - - This cmdlet is available or functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - Use the Test-ClientAccessRule cmdlet to test how client access rules affect access to your organization. If any of the client properties you specify for this cmdlet match any client access rules, the rules are returned in the results. - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-ClientAccessRule - - 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. - - ClientAccessAuthenticationMethod - - ClientAccessAuthenticationMethod - - - None - - - 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. - - ClientAccessProtocol - - ClientAccessProtocol - - - None - - - 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. - - IPAddress - - IPAddress - - - None - - - RemotePort - - The RemotePort parameter specifies the client TCP port to test. Valid input for this parameter is an integer from 1 to 65535. - - Int32 - - Int32 - - - None - - - User - - The User parameter specifies the user account to test. 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - OAuthClaims - - The OAuthClaims parameter specifies the OAuth claims token of a middle-tier app. - - Hashtable - - Hashtable - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - ClientAccessAuthenticationMethod - - ClientAccessAuthenticationMethod - - - None - - - 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. - - ClientAccessProtocol - - ClientAccessProtocol - - - None - - - 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. - - IPAddress - - IPAddress - - - None - - - RemotePort - - The RemotePort parameter specifies the client TCP port to test. Valid input for this parameter is an integer from 1 to 65535. - - Int32 - - Int32 - - - None - - - User - - The User parameter specifies the user account to test. 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. - - MailboxIdParameter - - MailboxIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - OAuthClaims - - The OAuthClaims parameter specifies the OAuth claims token of a middle-tier app. - - Hashtable - - Hashtable - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- 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 - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-clientaccessrule - - - - - - Test-M365DataAtRestEncryptionPolicy - Test - M365DataAtRestEncryptionPolicy - - 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. Note : We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Test-M365DataAtRestEncryptionPolicy - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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. - - DataEncryptionPolicyIdParameter - - DataEncryptionPolicyIdParameter - - - None - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - False - - - DomainController - - This parameter is reserved for internal Microsoft use. - - Fqdn - - Fqdn - - - None - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Test-M365DataAtRestEncryptionPolicy -Identity "Contoso Corporate" - - This example tests the Microsoft 365 data-at-rest encryption policy named Contoso Corporate. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/test-m365dataatrestencryptionpolicy - - - - - - Update-PublicFolderMailbox - Update - PublicFolderMailbox - - This cmdlet is available in 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - - - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - - - - Update-PublicFolderMailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - Update-PublicFolderMailbox - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - FullSync - - The FullSync switch specifies that you want to perform a full synchronization of the public folder mailbox. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - 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. - - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - - SwitchParameter - - - False - - - - - - 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) - - MailboxIdParameter - - MailboxIdParameter - - - None - - - 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. - - PublicFolderIdParameter - - PublicFolderIdParameter - - - None - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - - Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. - - Most other cmdlets (for example, New-\ and Set-\ cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - FullSync - - The FullSync switch specifies that you want to perform a full synchronization of the public folder mailbox. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - 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. - - SwitchParameter - - SwitchParameter - - - False - - - WhatIf - - The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - - - To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - - - - - - - - - - To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - - - - - - - - - - - -------------------------- Example 1 -------------------------- - Update-PublicFolderMailbox -Identity PF_marketing - - This example updates the public folder hierarchy on the public folder mailbox PF_marketing. - - - - -------------------------- Example 2 -------------------------- - Get-Mailbox -PublicFolder | Update-PublicFolderMailbox - - This example updates all public folder mailboxes. - - - - - - Online Version: - https://docs.microsoft.com/powershell/module/exchange/update-publicfoldermailbox - - - - diff --git a/ExecAlertsListAllTenants/function.json b/ExecAlertsListAllTenants/function.json deleted file mode 100644 index d4169b47b86d..000000000000 --- a/ExecAlertsListAllTenants/function.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "bindings": [ - { - "name": "QueueItem", - "type": "queueTrigger", - "direction": "in", - "queueName": "alertqueue" - } - ] -} diff --git a/ExecAlertsListAllTenants/run.ps1 b/ExecAlertsListAllTenants/run.ps1 deleted file mode 100644 index 4782d15619b9..000000000000 --- a/ExecAlertsListAllTenants/run.ps1 +++ /dev/null @@ -1,52 +0,0 @@ -# Input bindings are passed in via param block. -param( $QueueItem, $TriggerMetadata) - -# Write out the queue message and metadata to the information log. -Write-Host "PowerShell queue trigger function processed work item: $QueueItem" - -Get-Tenants | ForEach-Object -Parallel { - $domainName = $_.defaultDomainName - Import-Module CippCore - $Table = Get-CIPPTable -TableName 'cachealertsandincidents' - - try { - $Alerts = New-GraphGetRequest -uri 'https://graph.microsoft.com/beta/security/alerts' -tenantid $domainName - foreach ($Alert in $Alerts) { - $GUID = (New-Guid).Guid - $alertJson = $Alert | ConvertTo-Json - $GraphRequest = @{ - Alert = [string]$alertJson - RowKey = [string]$GUID - Tenant = $domainName - PartitionKey = 'alert' - } - Add-CIPPAzDataTableEntity @Table -Entity $GraphRequest -Force | Out-Null - - } - - } catch { - $GUID = (New-Guid).Guid - $AlertText = ConvertTo-Json -InputObject @{ - Title = "Could not connect to tenant to retrieve data: $($_.Exception.Message)" - Id = '' - Category = '' - EventDateTime = '' - Severity = '' - Status = '' - userStates = @('None') - vendorInformation = @{ - vendor = 'CIPP' - provider = 'CIPP' - } - } - $GraphRequest = @{ - Alert = [string]$AlertText - RowKey = [string]$GUID - PartitionKey = 'alert' - Tenant = $domainName - } - Add-CIPPAzDataTableEntity @Table -Entity $GraphRequest -Force | Out-Null - - - } -} \ No newline at end of file diff --git a/ExecGDAPInviteApproved_Timer/function.json b/ExecGDAPInviteApproved_Timer/function.json deleted file mode 100644 index f8904bbb0a7f..000000000000 --- a/ExecGDAPInviteApproved_Timer/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "type": "timerTrigger", - "direction": "in", - "schedule": "0 0 */3 * * *" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/ExecGDAPInviteApproved_Timer/run.ps1 b/ExecGDAPInviteApproved_Timer/run.ps1 deleted file mode 100644 index 08370014869f..000000000000 --- a/ExecGDAPInviteApproved_Timer/run.ps1 +++ /dev/null @@ -1,5 +0,0 @@ -using namespace System.Net - -param($Timer) - -Set-CIPPGDAPInviteGroups diff --git a/ExecIncidentsListAllTenants/function.json b/ExecIncidentsListAllTenants/function.json deleted file mode 100644 index 05f90b816f08..000000000000 --- a/ExecIncidentsListAllTenants/function.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "bindings": [ - { - "name": "QueueItem", - "type": "queueTrigger", - "direction": "in", - "queueName": "incidentqueue" - } - ] -} diff --git a/ExecIncidentsListAllTenants/run.ps1 b/ExecIncidentsListAllTenants/run.ps1 deleted file mode 100644 index 480b27d643d9..000000000000 --- a/ExecIncidentsListAllTenants/run.ps1 +++ /dev/null @@ -1,49 +0,0 @@ -# Input bindings are passed in via param block. -param( $QueueItem, $TriggerMetadata) - -# Write out the queue message and metadata to the information log. -Write-Host "PowerShell queue trigger function processed work item: $QueueItem" - -Get-Tenants | ForEach-Object -Parallel { - $domainName = $_.defaultDomainName - Import-Module CippCore - $Table = Get-CIPPTable -TableName 'cachealertsandincidents' - - try { - $incidents = New-GraphGetRequest -uri 'https://graph.microsoft.com/beta/security/incidents' -tenantid $domainName -AsApp $true - $GraphRequest = foreach ($incident in $incidents) { - $GUID = (New-Guid).Guid - $GraphRequest = @{ - Incident = [string]($incident | ConvertTo-Json -Depth 10) - RowKey = [string]$GUID - PartitionKey = 'Incident' - Tenant = [string]$domainName - } - Add-CIPPAzDataTableEntity @Table -Entity $GraphRequest -Force | Out-Null - } - - } catch { - $GUID = (New-Guid).Guid - $AlertText = ConvertTo-Json -InputObject @{ - Tenant = $domainName - displayName = "Could not connect to Tenant: $($_.Exception.Message)" - comments = @{ - createdDateTime = (Get-Date).ToString('s') - createdbyDisplayName = 'CIPP' - comment = 'Could not connect' - } - classification = 'Unknown' - determination = 'Unknown' - severity = 'CIPP' - } - $GraphRequest = @{ - Incident = [string]$AlertText - RowKey = [string]$GUID - PartitionKey = 'Incident' - Tenant = [string]$domainName - } - Add-CIPPAzDataTableEntity @Table -Entity $GraphRequest -Force | Out-Null - - - } -} \ No newline at end of file diff --git a/ExecMaintenanceScripts/Scripts/Add-CippUser.ps1 b/ExecMaintenanceScripts/Scripts/Add-CippUser.ps1 deleted file mode 100644 index d04ad2358c9d..000000000000 --- a/ExecMaintenanceScripts/Scripts/Add-CippUser.ps1 +++ /dev/null @@ -1,67 +0,0 @@ -#requires -Version 7.2 - -[CmdletBinding(DefaultParameterSetName = 'interactive')] -Param( - [Parameter(Mandatory = $true, ParameterSetName = 'noninteractive')] - [ValidateSet('readonly', 'editor', 'admin')] - $Role, - [Parameter(Mandatory = $true, ParameterSetName = 'noninteractive')] - $SelectedUsers, - [Parameter(ParameterSetName = 'noninteractive')] - [Parameter(ParameterSetName = 'interactive')] - $ExpirationHours = 1 -) - -$ResourceGroup = '##RESOURCEGROUP##' -$Subscription = '##SUBSCRIPTION##' - -if (!(Get-Module -ListAvailable Microsoft.PowerShell.ConsoleGuiTools)) { - Install-Module Microsoft.PowerShell.ConsoleGuiTools -Force -} - -$Context = Get-AzContext -if (!$Context) { - Write-Host "`n- Connecting to Azure" - $Context = Connect-AzAccount -Subscription $Subscription -} -Write-Host "Connected to $($Context.Account)" - -$swa = Get-AzStaticWebApp -ResourceGroupName $ResourceGroup -$Domain = $swa.CustomDomain | Select-Object -First 1 -if ($Domain -eq $null) { $Domain = $swa.DefaultHostname } -Write-Host "CIPP SWA - $($swa.name)" - -if (!$Role) { - $Role = @('readonly', 'editor', 'admin') | Out-ConsoleGridView -OutputMode Single -Title 'Select CIPP Role' -} - -$CurrentUsers = Get-AzStaticWebAppUser -Name $swa.name -ResourceGroupName $ResourceGroup -AuthProvider all | Select-Object DisplayName, Role - -$AllUsers = Get-AzADUser -Filter "userType eq 'Member' and accountEnabled eq true" | Select-Object DisplayName, UserPrincipalName - - -$SelectedUsers = $AllUsers | Where-Object { $CurrentUsers.DisplayName -notcontains $_.UserPrincipalName } | Sort-Object -Property DisplayName | Out-ConsoleGridView -Title "Select users for role '$Role'" -Write-Host "Selected users: $($SelectedUsers.UserPrincipalName -join ', ')" - -Write-Host 'Generating invite links...' -$InviteList = foreach ($User in $SelectedUsers) { - $UserInvite = @{ - InputObject = $swa - Domain = $Domain - Provider = 'aad' - UserDetail = $User.UserPrincipalName - Role = $Role - NumHoursToExpiration = $ExpirationHours - } - $Invite = New-AzStaticWebAppUserRoleInvitationLink @UserInvite - - [PSCustomObject]@{ - User = $User.UserPrincipalName - Role = $Role - Link = $Invite.InvitationUrl - Expires = $Invite.ExpiresOn - } -} -$InviteList -$InviteList | Export-Csv -Path '.\cipp-invites.csv' -Append -Write-Host 'Invitations exported to .\cipp-invites.csv' diff --git a/ExecMaintenanceScripts/Scripts/Enable-FunctionAppGitHubActions.ps1 b/ExecMaintenanceScripts/Scripts/Enable-FunctionAppGitHubActions.ps1 deleted file mode 100644 index a47273afad9e..000000000000 --- a/ExecMaintenanceScripts/Scripts/Enable-FunctionAppGitHubActions.ps1 +++ /dev/null @@ -1,38 +0,0 @@ -$ResourceGroup = '##RESOURCEGROUP##' -$Subscription = '##SUBSCRIPTION##' -$FunctionName = '##FUNCTIONAPP##' - -$Logo = @' - _____ _____ _____ _____ - / ____|_ _| __ \| __ \ - | | | | | |__) | |__) | - | | | | | ___/| ___/ - | |____ _| |_| | | | - \_____|_____|_| |_| - -'@ -Write-Host $Logo - -Write-Host '- Connecting to Azure' -Connect-AzAccount -Identity -Subscription $Subscription | Out-Null - -Write-Host 'Checking deployment settings' -$DeploymentSettings = & az functionapp deployment source show --resource-group $ResourceGroup --name $FunctionName | ConvertFrom-Json - -if (!($DeploymentSettings.isGitHubAction)) { - Write-Host 'Creating GitHub action, follow the prompts to log into GitHub' - $GitHubRepo = ([uri]$DeploymentSettings.repoUrl).LocalPath.TrimStart('/') - az functionapp deployment github-actions add --repo $GitHubRepo --branch $DeploymentSettings.branch --resource-group $ResourceGroup --name $FunctionName --login-with-github -} - -$DeploymentSettings = & az functionapp deployment source show --resource-group $ResourceGroup --name $FunctionName | ConvertFrom-Json -if ($DeploymentSettings.isGitHubAction) { - $cipp = Get-AzFunctionApp -ResourceGroupName $ResourceGroup - $cipp.ApplicationSettings['WEBSITE_RUN_FROM_PACKAGE'] = 1 - $cipp | Update-AzFunctionAppSetting -AppSetting $cipp.ApplicationSettings - - Write-Host "GitHub action created and project set to run from package, navigate to $($DeploymentSettings.repoUrl)/actions and run the 'Build and deploy Powershell project to Azure Function App'" -} -else { - Write-Host 'GitHub action not set up for deployment, try running the script again.' -} diff --git a/ExecMaintenanceScripts/Scripts/Grant-CippConditionalAccess.ps1 b/ExecMaintenanceScripts/Scripts/Grant-CippConditionalAccess.ps1 deleted file mode 100644 index b4460c2994d4..000000000000 --- a/ExecMaintenanceScripts/Scripts/Grant-CippConditionalAccess.ps1 +++ /dev/null @@ -1,122 +0,0 @@ -if (!(Get-Module -ListAvailable Microsoft.Graph)) { - Install-Module Microsoft.Graph -Confirm:$false -Force -AllowPrerelease -} - -$ResourceGroup = '##RESOURCEGROUP##' -$Subscription = '##SUBSCRIPTION##' -$FunctionName = '##FUNCTIONAPP##' -$TokenIP = '##TOKENIP##' - -$Logo = @' - _____ _____ _____ _____ - / ____|_ _| __ \| __ \ - | | | | | |__) | |__) | - | | | | | ___/| ___/ - | |____ _| |_| | | | - \_____|_____|_| |_| - -'@ -Write-Host $Logo - -Write-Host '=== Conditional Access Management ===' -if (Test-Path -Path '.\cipp-function-namedLocation.json') { - $UseCache = Read-Host -Prompt 'Used cached Named Location for CIPP? (Y/n)' - if ($UseCache -ne 'n') { - $ipNamedLocation = Get-Content -Path '.\cipp-function-namedLocation.json' | ConvertFrom-Json -AsHashtable - } -} - -if (!($ipNamedLocation)) { - Write-Host "`n- Connecting to Azure" - Connect-AzAccount -Identity -Subscription $Subscription | Out-Null - $Function = Get-AzFunctionApp -ResourceGroupName $ResourceGroup -Name $FunctionName - - Write-Host 'Getting Function App IP addresses' - # Get possible IPs from function app - $PossibleIpAddresses = (($Function | Select-Object -ExpandProperty PossibleOutboundIpAddress) + ',' + $TokenIP) -split ',' - - # Convert possible IP addresses to ipv4CidrRange list - $ipRanges = foreach ($Ip in $PossibleIpAddresses) { - $Cidr = '{0}/32' -f $Ip - @{ - '@odata.type' = '#microsoft.graph.iPv4CidrRange' - 'cidrAddress' = $Cidr - } - } - - # Return ipNamedLocation object - $ipNamedLocation = @{ - '@odata.type' = '#microsoft.graph.ipNamedLocation' - displayName = ('CyberDrain Improved Partner Portal - {0}' -f $FunctionName) - isTrusted = $true - ipRanges = $ipRanges - } - - $ipNamedLocation | ConvertTo-Json -Depth 10 | Out-File -Path '.\cipp-function-namedLocation.json' - Write-Host 'Named location policy created and saved to .\cipp-function-namedLocation.json' -} - -Write-Host "`n- Connecting to Customer Graph API, ensure you log in from a system that is allowed through the Conditional Access policy" -Select-MgProfile -Name 'beta' -$GraphOptions = @{ - Scopes = @('Policy.Read.All', 'Policy.ReadWrite.ConditionalAccess', 'Application.Read.All') - UseDeviceAuthentication = $true -} - -do { - Connect-MgGraph @GraphOptions - $Context = Get-MgContext - if ($Context) { - Write-Host "Connected as $($Context.Account) ($($Context.TenantId))" - $Switch = Read-Host -Prompt 'Switch Accounts? (y/N)' - if ($Switch -eq 'y') { - Disconnect-MgGraph | Out-Null - } - } -} -while (!(Get-MgContext)) - -Write-Host "`n- Getting existing policies" -$Policies = Get-MgIdentityConditionalAccessPolicy -Write-Host($Policies.displayName -join "`n") - -Write-Host "`n- Named Location Check" -$NamedLocations = Get-MgIdentityConditionalAccessNamedLocation -if ($NamedLocations.displayName -notcontains $ipNamedLocation.displayName) { - Write-Host "Creating Named Location: '$($ipNamedLocation.displayName)'" - $NamedLocation = New-MgIdentityConditionalAccessNamedLocation -BodyParameter $ipNamedLocation -} -else { - $NamedLocation = $NamedLocations | Where-Object { $_.displayName -eq $ipNamedLocation.displayName } - Write-Host "Named Location exists: '$($NamedLocation.displayName)'" - Update-MgIdentityConditionalAccessNamedLocation -NamedLocationId $NamedLocation.Id -BodyParameter $ipNamedLocation -} - -Write-Host "`n- Conditional access policy check" -$ConfigPolicy = Read-Host -Prompt 'Exclude CIPP from existing CA policies? (Y/n)' -if ($ConfigPolicy -ne 'n') { - foreach ($Policy in $Policies) { - Write-Host "- Policy: $($Policy.displayName)" - $Conditions = $Policy.Conditions - $ExcludeLocations = $Conditions.Locations.ExcludeLocations - $IncludeLocations = $Conditions.Locations.IncludeLocations - if ($ExcludeLocations -eq 'AllTrusted' -or $ExcludeLocations -contains $NamedLocation.Id) { - Write-Host 'Named location already excluded' - } - elseif ($IncludeLocations -eq 'AllTrusted' -or $IncludeLocations -contains $NamedLocation.Id) { - Write-Host 'Named location is already included' - } - else { - Write-Host 'Adding exclusion for named location' - $Locations = [system.collections.generic.list[string]]::new() - foreach ($Location in $ExcludeLocations) { - $Locations.Add($Location) | Out-Null - } - $Locations.Add($NamedLocation.Id) | Out-Null - $Conditions.Locations.ExcludeLocations = [string[]]$Locations - if (!($Conditions.Locations.IncludeLocations)) { $Conditions.Locations.IncludeLocations = 'All' } - Update-MgIdentityConditionalAccessPolicy -ConditionalAccessPolicyId $Policy.Id -Conditions $Conditions - } - } - Write-Host "`nDone." -} diff --git a/ExecOffboard_Mailboxpermissions/function.json b/ExecOffboard_Mailboxpermissions/function.json deleted file mode 100644 index bc64eceb6904..000000000000 --- a/ExecOffboard_Mailboxpermissions/function.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "bindings": [ - { - "name": "QueueItem", - "type": "queueTrigger", - "direction": "in", - "queueName": "offboardingmailbox" - } - ] -} diff --git a/ExecOffboard_Mailboxpermissions/run.ps1 b/ExecOffboard_Mailboxpermissions/run.ps1 deleted file mode 100644 index 755133d6586e..000000000000 --- a/ExecOffboard_Mailboxpermissions/run.ps1 +++ /dev/null @@ -1,8 +0,0 @@ -# Input bindings are passed in via param block. -param( $QueueItem, $TriggerMetadata) -$APIName = $TriggerMetadata.FunctionName - -$Mailboxes = New-ExoRequest -tenantid $QueueItem.TenantFilter -cmdlet "get-mailbox" -foreach ($Mailbox in $Mailboxes) { - Remove-CIPPMailboxPermissions -PermissionsLevel @("FullAccess", "SendAs", "SendOnBehalf") -userid $Mailbox.UserPrincipalName -AccessUser $QueueItem.User -TenantFilter $QueueItem.TenantFilter -APIName $APINAME -ExecutingUser $QueueItem.ExecutingUser -} \ No newline at end of file diff --git a/ExecSchedulerBillingRun/function.json b/ExecSchedulerBillingRun/function.json deleted file mode 100644 index 987ff96a991d..000000000000 --- a/ExecSchedulerBillingRun/function.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "bindings": [ - { - "name": "QueueItem", - "type": "queueTrigger", - "direction": "in", - "queueName": "billqueue" - } - ] -} diff --git a/ExecSchedulerBillingRun/run.ps1 b/ExecSchedulerBillingRun/run.ps1 deleted file mode 100644 index 3ea7e6621fac..000000000000 --- a/ExecSchedulerBillingRun/run.ps1 +++ /dev/null @@ -1,21 +0,0 @@ -# Input bindings are passed in via param block. -param($QueueItem) - -# Get the current universal time in the default string format. -try { - Write-LogMessage -API 'Scheduler_Billing' -tenant 'none' -message 'Starting billing processing.' -sev Info - - $Table = Get-CIPPTable -TableName Extensionsconfig - $Configuration = (Get-CIPPAzDataTableEntity @Table).config | ConvertFrom-Json -Depth 10 - foreach ($ConfigItem in $Configuration.psobject.properties.name) { - switch ($ConfigItem) { - 'Gradient' { - If ($Configuration.Gradient.enabled -and $Configuration.Gradient.BillingEnabled) { - New-GradientServiceSyncRun - } - } - } - } -} catch { - Write-LogMessage -API 'Scheduler_Billing' -tenant 'none' -message 'Could not start billing processing' -sev Error -LogData (Get-CippException -Exception $_) -} \ No newline at end of file diff --git a/ListGenericAllTenants/function.json b/ListGenericAllTenants/function.json deleted file mode 100644 index 4937476839a0..000000000000 --- a/ListGenericAllTenants/function.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "bindings": [ - { - "name": "QueueItem", - "type": "queueTrigger", - "direction": "in", - "queueName": "generalAllTenantQueue" - } - ] -} diff --git a/ListGenericAllTenants/run.ps1 b/ListGenericAllTenants/run.ps1 deleted file mode 100644 index afda8b0570d2..000000000000 --- a/ListGenericAllTenants/run.ps1 +++ /dev/null @@ -1,42 +0,0 @@ -# Input bindings are passed in via param block. -param([string]$QueueItem, $TriggerMetadata) - -# Write out the queue message and metadata to the information log. -Write-Host "PowerShell queue trigger function processed work item: $QueueItem" -$TableURLName = ($QueueItem.tolower().split('?').Split('/') | Select-Object -First 1).toString() -$QueueKey = (Invoke-ListCippQueue | Where-Object -Property Name -EQ $TableURLName | Select-Object -Last 1).RowKey -Update-CippQueueEntry -RowKey $QueueKey -Status 'Started' -$Table = Get-CIPPTable -TableName "cache$TableURLName" -$fullUrl = "https://graph.microsoft.com/beta/$QueueItem" -Get-CIPPAzDataTableEntity @Table | Remove-AzDataTableEntity @table - -$RawGraphRequest = Get-Tenants | ForEach-Object -Parallel { - $domainName = $_.defaultDomainName - Import-Module CippCore - try { - Write-Host $using:fullUrl - New-GraphGetRequest -uri $using:fullUrl -tenantid $_.defaultDomainName -ComplexFilter -ErrorAction Stop | Select-Object *, @{l = 'Tenant'; e = { $domainName } }, @{l = 'CippStatus'; e = { 'Good' } } - } - catch { - [PSCustomObject]@{ - Tenant = $domainName - CippStatus = "Could not connect to tenant. $($_.Exception.message)" - } - } -} - -Update-CippQueueEntry -RowKey $QueueKey -Status 'Processing' -foreach ($Request in $RawGraphRequest) { - $Json = ConvertTo-Json -Compress -InputObject $request - $GraphRequest = [PSCustomObject]@{ - Tenant = [string]$Request.tenant - RowKey = [string](New-Guid) - PartitionKey = [string]$URL - Data = [string]$Json - - } - Add-CIPPAzDataTableEntity @Table -Entity $GraphRequest -Force | Out-Null -} - - -Update-CippQueueEntry -RowKey $QueueKey -Status 'Completed' \ No newline at end of file diff --git a/PublicScripts/function.json b/PublicScripts/function.json deleted file mode 100644 index 306b0c51e560..000000000000 --- a/PublicScripts/function.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "bindings": [ - { - "authLevel": "anonymous", - "type": "httpTrigger", - "direction": "in", - "name": "Request", - "methods": [ - "get", - "post" - ] - }, - { - "type": "http", - "direction": "out", - "name": "Response" - } - ] -} \ No newline at end of file diff --git a/PublicScripts/run.ps1 b/PublicScripts/run.ps1 deleted file mode 100644 index 0dca13ac3c97..000000000000 --- a/PublicScripts/run.ps1 +++ /dev/null @@ -1,38 +0,0 @@ -using namespace System.Net - -# Input bindings are passed in via param block. -param($Request, $TriggerMetadata) - -$APIName = $TriggerMetadata.FunctionName -Write-LogMessage -user $request.headers.'x-ms-client-principal' -API $APINAME -message 'Accessed this API' -Sev 'Debug' - -# Write to the Azure Functions log stream. -Write-Host 'PowerShell HTTP trigger function processed a request.' - -$Table = Get-CippTable -TableName 'MaintenanceScripts' - -if (![string]::IsNullOrEmpty($Request.Query.Guid)) { - $Filter = "PartitionKey eq 'Maintenance' and RowKey eq '{0}'" -f $Request.Query.Guid - $ScriptRow = Get-CIPPAzDataTableEntity @Table -Filter $Filter - if ($ScriptRow) { - if ($ScriptRow.Timestamp.DateTime -lt (Get-Date).AddMinutes(-5)) { - $Body = 'Write-Host "Link expired"' - } - else { - $Body = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($ScriptRow.ScriptContent)) - } - Remove-AzDataTableEntity @Table -Entity $ScriptRow - } - else { - $Body = 'Write-Host "Invalid Script ID"' - } -} -else { - $Body = 'Write-Host "Script ID is required, generate a link from the Maintenance page"' -} - -# Associate values to output bindings by calling 'Push-OutputBinding'. -Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{ - StatusCode = [HttpStatusCode]::OK - Body = $body - }) diff --git a/Scheduler_Billing/function.json b/Scheduler_Billing/function.json deleted file mode 100644 index d2e7f34face4..000000000000 --- a/Scheduler_Billing/function.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "type": "timerTrigger", - "direction": "in", - "schedule": "0 0 0 * * *" - } - ] -} diff --git a/Scheduler_Billing/run.ps1 b/Scheduler_Billing/run.ps1 deleted file mode 100644 index 4c14defea81b..000000000000 --- a/Scheduler_Billing/run.ps1 +++ /dev/null @@ -1,22 +0,0 @@ -# Input bindings are passed in via param block. -param($Timer) - -# Get the current universal time in the default string format. -try { - Write-LogMessage -API "Scheduler_Billing" -tenant "none" -message "Starting billing processing." -sev Info - - $Table = Get-CIPPTable -TableName Extensionsconfig - $Configuration = (Get-CIPPAzDataTableEntity @Table).config | ConvertFrom-Json -Depth 10 - foreach ($ConfigItem in $Configuration.psobject.properties.name) { - switch ($ConfigItem) { - "Gradient" { - If ($Configuration.Gradient.enabled -and $Configuration.Gradient.BillingEnabled) { - New-GradientServiceSyncRun - } - } - } - } -} -catch { - Write-LogMessage -API "Scheduler_Billing" -tenant "none" -message "Could not start billing processing $($_.Exception.Message)" -sev Error -} \ No newline at end of file diff --git a/Scheduler_Extensions/function.json b/Scheduler_Extensions/function.json deleted file mode 100644 index c178a68af69f..000000000000 --- a/Scheduler_Extensions/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "schedule": "0 0 */2 * * *", - "direction": "in", - "type": "timerTrigger" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/Scheduler_Extensions/run.ps1 b/Scheduler_Extensions/run.ps1 deleted file mode 100644 index 58e228ebbe1d..000000000000 --- a/Scheduler_Extensions/run.ps1 +++ /dev/null @@ -1,14 +0,0 @@ -using namespace System.Net - -param($Timer) - -$Table = Get-CIPPTable -TableName Extensionsconfig - -$Configuration = ((Get-AzDataTableEntity @Table).config | ConvertFrom-Json) - -Write-Host 'Started Scheduler for Extensions' - -# NinjaOne Extension -if ($Configuration.NinjaOne.Enabled -eq $True) { - Invoke-NinjaOneExtensionScheduler -} \ No newline at end of file diff --git a/Scheduler_GetQueue/function.json b/Scheduler_GetQueue/function.json deleted file mode 100644 index 56e4cf0cfda1..000000000000 --- a/Scheduler_GetQueue/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "schedule": "0 0 * * * *", - "direction": "in", - "type": "timerTrigger" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/Scheduler_GetQueue/run.ps1 b/Scheduler_GetQueue/run.ps1 deleted file mode 100644 index 87d355d1476c..000000000000 --- a/Scheduler_GetQueue/run.ps1 +++ /dev/null @@ -1,52 +0,0 @@ -param($Timer) - -$Table = Get-CIPPTable -TableName SchedulerConfig -$Tenants = Get-CIPPAzDataTableEntity @Table | Where-Object -Property PartitionKey -NE 'WebhookAlert' - -$Tasks = foreach ($Tenant in $Tenants) { - if ($Tenant.tenant -ne 'AllTenants') { - [pscustomobject]@{ - Tenant = $Tenant.tenant - Tag = 'SingleTenant' - TenantID = $Tenant.tenantid - Type = $Tenant.type - RowKey = $Tenant.RowKey - } - } else { - Write-Information 'All tenants, doing them all' - $TenantList = Get-Tenants - foreach ($t in $TenantList) { - [pscustomobject]@{ - Tenant = $t.defaultDomainName - Tag = 'AllTenants' - TenantID = $t.customerId - Type = $Tenant.type - RowKey = $Tenant.RowKey - } - } - } -} - -$Queue = New-CippQueueEntry -Name 'Scheduler' -TotalTasks ($Tasks | Measure-Object).Count - -$Batch = foreach ($Task in $Tasks) { - [pscustomobject]@{ - Tenant = $task.tenant - Tenantid = $task.tenantid - Tag = $task.tag - Type = $task.type - QueueId = $Queue.RowKey - SchedulerRow = $Task.RowKey - QueueName = '{0} - {1}' -f $Task.Type, $task.tenant - FunctionName = "Scheduler$($Task.Type)" - } -} -$InputObject = [PSCustomObject]@{ - OrchestratorName = 'SchedulerOrchestrator' - Batch = @($Batch) - SkipLog = $true -} -#Write-Information ($InputObject | ConvertTo-Json) -$InstanceId = Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Depth 5 -Compress) -Write-Information "Started orchestration with ID = '$InstanceId'" -#$Orchestrator = New-OrchestrationCheckStatusResponse -Request $Request -InstanceId $InstanceId \ No newline at end of file diff --git a/Scheduler_GetWebhooks/function.json b/Scheduler_GetWebhooks/function.json deleted file mode 100644 index f30537d11b34..000000000000 --- a/Scheduler_GetWebhooks/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "schedule": "0 */15 * * * *", - "direction": "in", - "type": "timerTrigger" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/Scheduler_GetWebhooks/run.ps1 b/Scheduler_GetWebhooks/run.ps1 deleted file mode 100644 index cef8cfb6d726..000000000000 --- a/Scheduler_GetWebhooks/run.ps1 +++ /dev/null @@ -1,26 +0,0 @@ -param($Timer) - -try { - - $webhookTable = Get-CIPPTable -tablename webhookTable - $Webhooks = Get-CIPPAzDataTableEntity @webhookTable -Property PartitionKey, RowKey - if (($Webhooks | Measure-Object).Count -eq 0) { - Write-Host 'No webhook subscriptions found. Exiting.' - return - } - Write-Host 'Processing webhooks' - - $InputObject = [PSCustomObject]@{ - OrchestratorName = 'WebhookOrchestrator' - QueueFunction = @{ - FunctionName = 'GetPendingWebhooks' - } - SkipLog = $true - } - Write-Host ($InputObject | ConvertTo-Json -Depth 5) - $InstanceId = Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Depth 5 -Compress) - Write-Host "Started orchestration with ID = '$InstanceId'" -} catch { - Write-LogMessage -API 'Webhooks' -message 'Error processing webhooks' -sev Error -LogData (Get-CippException -Exception $_) - Write-Host ( 'Webhook error {0} line {1} - {2}' -f $_.InvocationInfo.ScriptName, $_.InvocationInfo.ScriptLineNumber, $_.Exception.Message) -} diff --git a/Scheduler_PollAuditLogs/run.ps1 b/Scheduler_PollAuditLogs/run.ps1 index 4913f8570d52..3d99de1a7b62 100644 --- a/Scheduler_PollAuditLogs/run.ps1 +++ b/Scheduler_PollAuditLogs/run.ps1 @@ -1,6 +1,14 @@ param($Timer) try { + $ConfigTable = Get-CIPPTable -tablename Config + $Config = Get-CIPPAzDataTableEntity @ConfigTable -Filter "PartitionKey eq 'OffloadFunctions' and RowKey eq 'OffloadFunctions'" + + if ($Config -and $Config.state -ne $true) { + Write-Host 'Offload functions are not enabled. Exiting.' + return 0 + } + $webhookTable = Get-CIPPTable -tablename webhookTable $Webhooks = Get-CIPPAzDataTableEntity @webhookTable -Filter "Version eq '3'" | Where-Object { $_.Resource -match '^Audit' -and $_.Status -ne 'Disabled' } if (($Webhooks | Measure-Object).Count -eq 0) { diff --git a/Scheduler_RenewGraphSubscriptions/function.json b/Scheduler_RenewGraphSubscriptions/function.json deleted file mode 100644 index 114e4c0f7aab..000000000000 --- a/Scheduler_RenewGraphSubscriptions/function.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "type": "timerTrigger", - "direction": "in", - "schedule": "0 10 * * * *" - } - ] -} diff --git a/Scheduler_RenewGraphSubscriptions/run.ps1 b/Scheduler_RenewGraphSubscriptions/run.ps1 deleted file mode 100644 index b688e87e8b17..000000000000 --- a/Scheduler_RenewGraphSubscriptions/run.ps1 +++ /dev/null @@ -1,10 +0,0 @@ -# Input bindings are passed in via param block. -param($Timer) - -# Get the current universal time in the default string format. -try { - Write-LogMessage -API "Scheduler_RenewGraphSubscriptions" -tenant "none" -message "Starting Graph Subscription Renewal" -sev Info - Invoke-CippGraphWebhookRenewal -} catch { - Write-LogMessage -API "Scheduler_RenewGraphSubscriptions" -tenant "none" -message "Failed to renew graph subscriptions" -sev Info -} \ No newline at end of file diff --git a/Scheduler_Standards/function.json b/Scheduler_Standards/function.json deleted file mode 100644 index e071591357a0..000000000000 --- a/Scheduler_Standards/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "schedule": "0 0 */4 * * *", - "direction": "in", - "type": "timerTrigger" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/Scheduler_Standards/run.ps1 b/Scheduler_Standards/run.ps1 deleted file mode 100644 index 7466a60f5338..000000000000 --- a/Scheduler_Standards/run.ps1 +++ /dev/null @@ -1,6 +0,0 @@ -using namespace System.Net - -param($Timer) -Write-LogMessage -API 'Standards' -message 'Starting Standards Schedule' -sev Info -Invoke-CIPPStandardsRun -tenantfilter 'allTenants' -Write-LogMessage -API 'Standards' -message 'Launched all standard jobs' -sev Info \ No newline at end of file diff --git a/Scheduler_UserTasks/function.json b/Scheduler_UserTasks/function.json deleted file mode 100644 index f7af84092121..000000000000 --- a/Scheduler_UserTasks/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "schedule": "0 */15 * * * *", - "direction": "in", - "type": "timerTrigger" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/Scheduler_UserTasks/run.ps1 b/Scheduler_UserTasks/run.ps1 deleted file mode 100644 index 950ca9e691bb..000000000000 --- a/Scheduler_UserTasks/run.ps1 +++ /dev/null @@ -1,74 +0,0 @@ -param($Timer) - -$Table = Get-CippTable -tablename 'ScheduledTasks' -$Filter = "TaskState eq 'Planned' or TaskState eq 'Failed - Planned'" -$tasks = Get-CIPPAzDataTableEntity @Table -Filter $Filter -$Batch = [System.Collections.Generic.List[object]]::new() -foreach ($task in $tasks) { - $tenant = $task.Tenant - $currentUnixTime = [int64](([datetime]::UtcNow) - (Get-Date '1/1/1970')).TotalSeconds - if ($currentUnixTime -ge $task.ScheduledTime) { - try { - $null = Update-AzDataTableEntity @Table -Entity @{ - PartitionKey = $task.PartitionKey - RowKey = $task.RowKey - ExecutedTime = "$currentUnixTime" - TaskState = 'Running' - } - $task.Parameters = $task.Parameters | ConvertFrom-Json -AsHashtable - $task.AdditionalProperties = $task.AdditionalProperties | ConvertFrom-Json - - if (!$task.Parameters) { $task.Parameters = @{} } - $ScheduledCommand = [pscustomobject]@{ - Command = $task.Command - Parameters = $task.Parameters - TaskInfo = $task - FunctionName = 'ExecScheduledCommand' - } - - if ($task.Tenant -eq 'AllTenants') { - $AllTenantCommands = foreach ($Tenant in Get-Tenants) { - $NewParams = $task.Parameters.Clone() - $NewParams.TenantFilter = $Tenant.defaultDomainName - [pscustomobject]@{ - Command = $task.Command - Parameters = $NewParams - TaskInfo = $task - FunctionName = 'ExecScheduledCommand' - } - } - $Batch.AddRange($AllTenantCommands) - } else { - $ScheduledCommand.Parameters['TenantFilter'] = $task.Tenant - $Batch.Add($ScheduledCommand) - } - } catch { - $errorMessage = $_.Exception.Message - - $null = Update-AzDataTableEntity @Table -Entity @{ - PartitionKey = $task.PartitionKey - RowKey = $task.RowKey - Results = "$errorMessage" - ExecutedTime = "$currentUnixTime" - TaskState = 'Failed' - } - Write-LogMessage -API 'Scheduler_UserTasks' -tenant $tenant -message "Failed to execute task $($task.Name): $errorMessage" -sev Error - } - } -} -if (($Batch | Measure-Object).Count -gt 0) { - # Create queue entry - $Queue = New-CippQueueEntry -Name 'Scheduled Tasks' -TotalTasks ($Batch | Measure-Object).Count - $QueueId = $Queue.RowKey - $Batch = $Batch | Select-Object *, @{Name = 'QueueId'; Expression = { $QueueId } }, @{Name = 'QueueName'; Expression = { '{0} - {1}' -f $_.TaskInfo.Name, ($_.TaskInfo.Tenant -ne 'AllTenants' ? $_.TaskInfo.Tenant : $_.Parameters.TenantFilter) } } - - $InputObject = [PSCustomObject]@{ - OrchestratorName = 'UserTaskOrchestrator' - Batch = @($Batch) - SkipLog = $true - } - #Write-Host ($InputObject | ConvertTo-Json -Depth 10) - $InstanceId = Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Depth 10 -Compress) - - Write-Host "Started orchestration with ID = '$InstanceId'" -} diff --git a/SendStats/function.json b/SendStats/function.json deleted file mode 100644 index b47dd4f6ee24..000000000000 --- a/SendStats/function.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "type": "timerTrigger", - "direction": "in", - "schedule": "0 0 0 * * *" - } - ] -} \ No newline at end of file diff --git a/SendStats/run.ps1 b/SendStats/run.ps1 deleted file mode 100644 index 2e30b113ab55..000000000000 --- a/SendStats/run.ps1 +++ /dev/null @@ -1,23 +0,0 @@ -# Input bindings are passed in via param block. -param($Timer) - -#These stats are sent to a central server to help us understand how many tenants are using the product, and how many are using the latest version, this information allows the CIPP team to make decisions about what features to support, and what features to deprecate. -#We will never ship any data that is related to your instance, all we care about is the number of tenants, and the version of the API you are running, and if you completed setup. - -if ($ENV:applicationid -ne 'LongApplicationID') { - $SetupComplete = $true -} -$TenantCount = (Get-Tenants).count - -Set-Location (Get-Item $PSScriptRoot).Parent.FullName -$APIVersion = Get-Content 'version_latest.txt' | Out-String - -$SendingObject = [PSCustomObject]@{ - rgid = $env:WEBSITE_SITE_NAME - SetupComplete = $SetupComplete - RunningVersionAPI = $APIVersion.trim() - CountOfTotalTenants = $tenantcount - uid = $env:TenantID -} | ConvertTo-Json - -Invoke-RestMethod -Uri 'https://management.cipp.app/api/stats' -Method POST -Body $SendingObject -ContentType 'application/json' \ No newline at end of file diff --git a/Tools/Clear-DevEnvironment.ps1 b/Tools/Clear-DevEnvironment.ps1 deleted file mode 100644 index a96f369dc04b..000000000000 --- a/Tools/Clear-DevEnvironment.ps1 +++ /dev/null @@ -1,4 +0,0 @@ -$EnvironmentVariables = @('TenantId', 'ApplicationId', 'ApplicationSecret', 'RefreshToken', 'AzureWebJobsStorage', 'PartnerTenantAvailable', 'SetFromProfile') -ForEach ($Key in $EnvironmentVariables) { - [Environment]::SetEnvironmentVariable($Key, $null) -} \ No newline at end of file diff --git a/Tools/Confirm-FunctionRequirements.ps1 b/Tools/Confirm-FunctionRequirements.ps1 deleted file mode 100644 index 8fad9fc9b1e0..000000000000 --- a/Tools/Confirm-FunctionRequirements.ps1 +++ /dev/null @@ -1,79 +0,0 @@ -# Set CippRoot directory and process requirements.psd1 -$CippRoot = (Get-Item $PSScriptRoot).Parent.FullName -$Requirements = & { Get-Content $CippRoot\requirements.psd1 -Raw | Invoke-Expression } -$Modules = $Requirements.Keys - -# Exclude top level Modules and Tools directories -$Exclude = @( - 'Modules' - 'Tools' -) -$Files = Get-ChildItem $CippRoot -Exclude $Exclude | Get-ChildItem -Recurse -Include @('*.ps1', '*.psm1') - -# Process each module in requirements -$ModuleTests = $Modules | ForEach-Object -Parallel { - $ModuleRefs = 0 - $Success = $true - $Module = $_ - - try { - # Update module from gallery - Save-Module -Name $Module -Path $using:CippRoot\Modules - $ModuleInfo = Get-Module $using:CippRoot\Modules\$Module -ListAvailable - - # Remove old versions - while (($ModuleInfo | Measure-Object).Count -gt 1) { - Remove-Module $Module - $RemoveVersion = $ModuleInfo | Sort-Object -Property Version | Select-Object -First 1 - Remove-Item -Path $RemoveVersion.ModuleBase -Recurse - } - - # Check for module - if (-not ($ModuleInfo)) { - Import-Module $using:CippRoot\Modules\$Module -Force -ErrorAction Stop - } - - # Get list of module commands - $Commands = (Get-Command -Module $Module -ErrorAction Stop).Name - - # Review all powershell files and search for module commands - $Files = foreach ($File in $using:Files) { - $References = 0 - $Content = Get-Content -Raw $File - $MatchedCommands = foreach ($Command in $Commands) { - if ($Content | Select-String -Pattern $Command) { - $References++ - $ModuleRefs++ - $Command - } - } - if ($References -gt 0) { - [pscustomobject]@{ - File = $File | Resolve-Path -Relative - References = $References - Commands = $MatchedCommands - } - } - } - if ($ModuleRefs -eq 0) { - $ErrorMsg = 'No references found' - $Success = $false - } - } - catch { - $ErrorMsg = $_.Exception.Message - $Success = $false - } - - # Return processed module object - [pscustomobject]@{ - Module = $Module - Version = $ModuleInfo.Version - References = $ModuleRefs - Files = $Files - ErrorMsg = $ErrorMsg - Success = $Success - } -} - -$ModuleTests diff --git a/Tools/Initialize-DevEnvironment.ps1 b/Tools/Initialize-DevEnvironment.ps1 deleted file mode 100644 index 8612e74156cf..000000000000 --- a/Tools/Initialize-DevEnvironment.ps1 +++ /dev/null @@ -1,17 +0,0 @@ -$CippRoot = (Get-Item $PSScriptRoot).Parent.FullName -### Read the local.settings.json file and convert to a PowerShell object. -$CIPPSettings = Get-Content "$CippRoot\local.settings.json" | ConvertFrom-Json | Select-Object -ExpandProperty Values -### Loop through the settings and set environment variables for each. -$ValidKeys = @('TenantId', 'ApplicationId', 'ApplicationSecret', 'RefreshToken', 'AzureWebJobsStorage', 'PartnerTenantAvailable', 'SetFromProfile') -ForEach ($Key in $CIPPSettings.PSObject.Properties.Name) { - if ($ValidKeys -Contains $Key) { - [Environment]::SetEnvironmentVariable($Key, $CippSettings.$Key) - } -} - -Import-Module "$CippRoot\Modules\AzBobbyTables" -Import-Module "$CippRoot\Modules\DNSHealth" -Import-Module "$CippRoot\Modules\CippCore" -Import-Module "$CippRoot\Modules\CippExtensions" - -Get-CIPPAuthentication diff --git a/Tools/Update-StandardsComments.ps1 b/Tools/Update-StandardsComments.ps1 deleted file mode 100644 index c47bb4d4a6cb..000000000000 --- a/Tools/Update-StandardsComments.ps1 +++ /dev/null @@ -1,134 +0,0 @@ -<# -.SYNOPSIS - This script updates the comment block in the CIPP standard files. - -.DESCRIPTION - The script reads the standards.json file and updates the comment block in the corresponding CIPP standard files. - It adds or modifies the comment block based on the properties defined in the standards.json file. - This is made to be able to generate the help documentation for the CIPP standards automatically. - -.INPUTS - None. You cannot pipe objects to this script. - -.OUTPUTS - None. The script modifies the CIPP standard files directly. - -.NOTES - .FUNCTIONALITY Internal needs to be present in the comment block for the script, otherwise it will not be updated. - This is done as a safety measure to avoid updating the wrong files. - -.EXAMPLE - Update-StandardsComments.ps1 - - This example runs the script to update the comment block in the CIPP standard files. - -#> -param ( - [switch]$WhatIf -) - - -function EscapeMarkdown([object]$InputObject) { - # https://github.com/microsoft/FormatPowerShellToMarkdownTable/blob/master/src/FormatMarkdownTable/FormatMarkdownTable.psm1 - $Temp = '' - - if ($null -eq $InputObject) { - return '' - } elseif ($InputObject.GetType().BaseType -eq [System.Array]) { - $Temp = '{' + [System.String]::Join(', ', $InputObject) + '}' - } elseif ($InputObject.GetType() -eq [System.Collections.ArrayList] -or $InputObject.GetType().ToString().StartsWith('System.Collections.Generic.List')) { - $Temp = '{' + [System.String]::Join(', ', $InputObject.ToArray()) + '}' - } elseif (Get-Member -InputObject $InputObject -Name ToString -MemberType Method) { - $Temp = $InputObject.ToString() - } else { - $Temp = '' - } - - return $Temp.Replace('\', '\\').Replace('*', '\*').Replace('_', '\_').Replace("``", "\``").Replace('$', '\$').Replace('|', '\|').Replace('<', '\<').Replace('>', '\>').Replace([System.Environment]::NewLine, '
') -} - - -# Find the paths to the standards.json file based on the current script path -$StandardsJSONPath = Split-Path (Split-Path $PSScriptRoot) -$StandardsJSONPath = Resolve-Path "$StandardsJSONPath\*\src\data\standards.json" -$StandardsInfo = Get-Content -Path $StandardsJSONPath | ConvertFrom-Json -Depth 10 - -foreach ($Standard in $StandardsInfo) { - - # Calculate the standards file name and path - $StandardFileName = $Standard.name -replace 'standards.', 'Invoke-CIPPStandard' - $StandardsFilePath = Resolve-Path "$(Split-Path $PSScriptRoot)\Modules\CIPPCore\Public\Standards\$StandardFileName.ps1" - if (-not (Test-Path $StandardsFilePath)) { - Write-Host "No file found for standard $($Standard.name)" -ForegroundColor Yellow - continue - } - $Content = (Get-Content -Path $StandardsFilePath -Raw).TrimEnd() + "`r`n" - - # Remove random newlines before the param block - $regexPattern = '#>\s*\r?\n\s*\r?\n\s*param' - $Content = $Content -replace $regexPattern, "#>`r`n`r`n param" - - # Regex to match the existing comment block - $Regex = '<#(.|\n)*?\.FUNCTIONALITY\s*Internal(.|\n)*?#>' - - if ($Content -match $Regex) { - $NewComment = [System.Collections.Generic.List[string]]::new() - # Add the initial scatic comments - $NewComment.Add("<#`r`n") - $NewComment.Add(" .FUNCTIONALITY`r`n") - $NewComment.Add(" Internal`r`n") - $NewComment.Add(" .COMPONENT`r`n") - $NewComment.Add(" (APIName) $($Standard.name -replace 'standards.', '')`r`n") - $NewComment.Add(" .SYNOPSIS`r`n") - $NewComment.Add(" (Label) $($Standard.label.ToString())`r`n") - $NewComment.Add(" .DESCRIPTION`r`n") - if ([string]::IsNullOrWhiteSpace($Standard.docsDescription)) { - $NewComment.Add(" (Helptext) $($Standard.helpText.ToString())`r`n") - $NewComment.Add(" (DocsDescription) $(EscapeMarkdown($Standard.helpText.ToString()))`r`n") - } else { - $NewComment.Add(" (Helptext) $($Standard.helpText.ToString())`r`n") - $NewComment.Add(" (DocsDescription) $(EscapeMarkdown($Standard.docsDescription.ToString()))`r`n") - } - $NewComment.Add(" .NOTES`r`n") - - # Loop through the rest of the properties of the standard and add them to the NOTES field - foreach ($Property in $Standard.PSObject.Properties) { - switch ($Property.Name) { - 'name' { continue } - 'impactColour' { continue } - 'docsDescription' { continue } - 'helpText' { continue } - 'label' { continue } - Default { - $NewComment.Add(" $($Property.Name.ToUpper())`r`n") - if ($Property.Value -is [System.Object[]]) { - foreach ($Value in $Property.Value) { - $NewComment.Add(" $(ConvertTo-Json -InputObject $Value -Depth 5 -Compress)`r`n") - } - continue - } - $NewComment.Add(" $(EscapeMarkdown($Property.Value.ToString()))`r`n") - } - } - - } - - # Add header about how to update the comment block with this script - $NewComment.Add(" UPDATECOMMENTBLOCK`r`n") - $NewComment.Add(" Run the Tools\Update-StandardsComments.ps1 script to update this comment block`r`n") - # -Online help link - $NewComment.Add(" .LINK`r`n") - $NewComment.Add(" https://docs.cipp.app/user-documentation/tenant/standards/edit-standards`r`n") - $NewComment.Add(' #>') - - # Write the new comment block to the file - if ($WhatIf.IsPresent) { - Write-Host "Would update $StandardsFilePath with the following comment block:" - $NewComment - } else { - $Content -replace $Regex, $NewComment | Set-Content -Path $StandardsFilePath -Encoding utf8 -NoNewline - } - } else { - Write-Host "No comment block found in $StandardsFilePath" -ForegroundColor Yellow - } -} diff --git a/UpdatePermissions/function.json b/UpdatePermissions/function.json deleted file mode 100644 index 7e97fe568d29..000000000000 --- a/UpdatePermissions/function.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "type": "timerTrigger", - "direction": "in", - "schedule": "0 0 0 * * *" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/UpdatePermissions/run.ps1 b/UpdatePermissions/run.ps1 deleted file mode 100644 index e99383ecc69b..000000000000 --- a/UpdatePermissions/run.ps1 +++ /dev/null @@ -1,30 +0,0 @@ -# Input bindings are passed in via param block. -param($Timer) - -try { - $Tenants = Get-Tenants -IncludeAll | Where-Object { $_.customerId -ne $env:TenantId -and $_.Excluded -eq $false } - $CPVTable = Get-CIPPTable -TableName cpvtenants - $CPVRows = Get-CIPPAzDataTableEntity @CPVTable - $ModuleRoot = (Get-Module CIPPCore).ModuleBase - $SAMManifest = Get-Item -Path "$ModuleRoot\Public\SAMManifest.json" - $AdditionalPermissions = Get-Item -Path "$ModuleRoot\Public\AdditionalPermissions.json" - $Tenants = $Tenants | ForEach-Object { - $CPVRow = $CPVRows | Where-Object -Property Tenant -EQ $_.customerId - if (!$CPVRow -or $env:ApplicationID -notin $CPVRow.applicationId -or $SAMManifest.LastWriteTime.ToUniversalTime() -gt $CPVRow.Timestamp.DateTime -or $AdditionalPermissions.LastWriteTime.ToUniversalTime() -ge $CPVRow.Timestamp.DateTime -or $CPVRow.Timestamp.DateTime -le (Get-Date).AddDays(-7).ToUniversalTime() -or !$_.defaultDomainName) { - $_ - } - } - $TenantCount = ($Tenants | Measure-Object).Count - if ($TenantCount -gt 0) { - $Queue = New-CippQueueEntry -Name 'Update Permissions' -TotalTasks $TenantCount - $TenantBatch = $Tenants | Select-Object defaultDomainName, customerId, displayName, @{n = 'FunctionName'; exp = { 'UpdatePermissionsQueue' } }, @{n = 'QueueId'; exp = { $Queue.RowKey } } - $InputObject = [PSCustomObject]@{ - OrchestratorName = 'UpdatePermissionsOrchestrator' - Batch = @($TenantBatch) - } - $InstanceId = Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Depth 5 -Compress) - Write-Host "Started permissions orchestration with ID = '$InstanceId'" - } else { - Write-Host 'No tenants require permissions update' - } -} catch {} diff --git a/UpdateTokens/function.json b/UpdateTokens/function.json deleted file mode 100644 index 828a2484ee7d..000000000000 --- a/UpdateTokens/function.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "bindings": [ - { - "name": "Timer", - "type": "timerTrigger", - "direction": "in", - "schedule": "0 0 0 * * 0" - } - ] -} \ No newline at end of file diff --git a/UpdateTokens/run.ps1 b/UpdateTokens/run.ps1 deleted file mode 100644 index ed20d6a67fbf..000000000000 --- a/UpdateTokens/run.ps1 +++ /dev/null @@ -1,33 +0,0 @@ -# Input bindings are passed in via param block. -param($Timer) - -# Get the current universal time in the default string format. -$currentUTCtime = (Get-Date).ToUniversalTime() - -$Refreshtoken = (Get-GraphToken -ReturnRefresh $true).Refresh_token - -if ($env:AzureWebJobsStorage -eq 'UseDevelopmentStorage=true') { - $Table = Get-CIPPTable -tablename 'DevSecrets' - $Secret = Get-CIPPAzDataTableEntity @Table -Filter "PartitionKey eq 'Secret' and RowKey eq 'Secret'" - if ($Secret) { - $Secret.RefreshToken = $Refreshtoken - Add-AzDataTableEntity @Table -Entity $Secret - } else { - Write-LogMessage -message 'Could not update refresh token. Will try again in 7 days.' -sev 'CRITICAL' - } -} else { - if ($env:MSI_SECRET) { - Disable-AzContextAutosave -Scope Process | Out-Null - $AzSession = Connect-AzAccount -Identity - } - $KV = $ENV:WEBSITE_DEPLOYMENT_ID - if ($Refreshtoken) { - Set-AzKeyVaultSecret -VaultName $kv -Name 'RefreshToken' -SecretValue (ConvertTo-SecureString -String $Refreshtoken -AsPlainText -Force) - } else { - Write-LogMessage -message 'Could not update refresh token. Will try again in 7 days.' -sev 'CRITICAL' - } -} - -# Write an information log with the current time. -Write-Host "PowerShell timer trigger function ran! TIME: $currentUTCtime" - diff --git a/Z_CIPPHttpTrigger/function.json b/Z_CIPPHttpTrigger/function.json deleted file mode 100644 index 179d246817ff..000000000000 --- a/Z_CIPPHttpTrigger/function.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "scriptFile": "../Modules/CippEntrypoints/CippEntrypoints.psm1", - "entryPoint": "Receive-CippHttpTrigger", - "bindings": [ - { - "authLevel": "anonymous", - "type": "httpTrigger", - "direction": "in", - "name": "Request", - "methods": ["get", "post"], - "route": "{CIPPEndpoint}" - }, - { - "type": "http", - "direction": "out", - "name": "Response" - }, - { - "type": "queue", - "direction": "out", - "name": "QueueItem", - "queueName": "CIPPGenericQueue" - }, - { - "type": "queue", - "direction": "out", - "name": "Subscription", - "queueName": "AlertSubscriptions" - }, - { - "type": "queue", - "direction": "out", - "name": "mailboxstats", - "queueName": "generalAllTenantQueue" - }, - { - "type": "queue", - "direction": "out", - "name": "gradientqueue", - "queueName": "billqueue" - }, - { - "type": "queue", - "direction": "out", - "name": "alertqueue", - "queueName": "alertqueue" - }, - { - "type": "queue", - "direction": "out", - "name": "gdapqueue", - "queueName": "gdapqueue" - }, - { - "type": "queue", - "direction": "out", - "name": "incidentqueue", - "queueName": "incidentqueue" - }, - { - "type": "queue", - "direction": "out", - "name": "offboardingmailbox", - "queueName": "offboardingmailbox" - }, - { - "name": "starter", - "type": "durableClient", - "direction": "in" - } - ] -} diff --git a/Z_CIPPQueueTrigger/function.json b/Z_CIPPQueueTrigger/function.json deleted file mode 100644 index 4d818463ea75..000000000000 --- a/Z_CIPPQueueTrigger/function.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "scriptFile": "../Modules/CippEntryPoints/CippEntryPoints.psm1", - "entryPoint": "Receive-CippQueueTrigger", - "bindings": [ - { - "name": "QueueItem", - "type": "queueTrigger", - "direction": "in", - "queueName": "CIPPGenericQueue" - }, - { - "type": "queue", - "direction": "out", - "name": "QueueItemOut", - "queueName": "CIPPGenericQueue" - } - ] -}